package tgbotapi import ( "encoding/json" "errors" "fmt" "net/url" "strings" "time" ) // APIResponse is a response from the Telegram API with the result // stored raw. type APIResponse struct { Ok bool `json:"ok"` Result json.RawMessage `json:"result,omitempty"` ErrorCode int `json:"error_code,omitempty"` Description string `json:"description,omitempty"` Parameters *ResponseParameters `json:"parameters,omitempty"` } // Error is an error containing extra information returned by the Telegram API. type Error struct { Code int Message string ResponseParameters } // Error message string. func (e Error) Error() string { return e.Message } // Update is an update response, from GetUpdates. type Update struct { // UpdateID is the update's unique identifier. // Update identifiers start from a certain positive number and increase // sequentially. // This ID becomes especially handy if you're using Webhooks, // since it allows you to ignore repeated updates or to restore // the correct update sequence, should they get out of order. // If there are no new updates for at least a week, then identifier // of the next update will be chosen randomly instead of sequentially. UpdateID int `json:"update_id"` // Message new incoming message of any kind — text, photo, sticker, etc. // // optional Message *Message `json:"message,omitempty"` // EditedMessage new version of a message that is known to the bot and was // edited // // optional EditedMessage *Message `json:"edited_message,omitempty"` // ChannelPost new version of a message that is known to the bot and was // edited // // optional ChannelPost *Message `json:"channel_post,omitempty"` // EditedChannelPost new incoming channel post of any kind — text, photo, // sticker, etc. // // optional EditedChannelPost *Message `json:"edited_channel_post,omitempty"` // InlineQuery new incoming inline query // // optional InlineQuery *InlineQuery `json:"inline_query,omitempty"` // ChosenInlineResult is 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. // // optional ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result,omitempty"` // CallbackQuery new incoming callback query // // optional CallbackQuery *CallbackQuery `json:"callback_query,omitempty"` // ShippingQuery new incoming shipping query. Only for invoices with // flexible price // // optional ShippingQuery *ShippingQuery `json:"shipping_query,omitempty"` // PreCheckoutQuery new incoming pre-checkout query. Contains full // information about checkout // // optional PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query,omitempty"` // Pool new poll state. Bots receive only updates about stopped polls and // polls, which are sent by the bot // // optional Poll *Poll `json:"poll,omitempty"` // PollAnswer user changed their answer in a non-anonymous poll. Bots // receive new votes only in polls that were sent by the bot itself. // // optional PollAnswer *PollAnswer `json:"poll_answer,omitempty"` // MyChatMember is 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. // // optional MyChatMember *ChatMemberUpdated `json:"my_chat_member"` // ChatMember is 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. // // optional ChatMember *ChatMemberUpdated `json:"chat_member"` // ChatJoinRequest is 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. // // optional ChatJoinRequest *ChatJoinRequest `json:"chat_join_request"` } // UpdatesChannel is the channel for getting updates. type UpdatesChannel <-chan Update // Clear discards all unprocessed incoming updates. func (ch UpdatesChannel) Clear() { for len(ch) != 0 { <-ch } } // User represents a Telegram user or bot. type User struct { // ID is a unique identifier for this user or bot ID int64 `json:"id"` // IsBot true, if this user is a bot // // optional IsBot bool `json:"is_bot,omitempty"` // FirstName user's or bot's first name FirstName string `json:"first_name"` // LastName user's or bot's last name // // optional LastName string `json:"last_name,omitempty"` // UserName user's or bot's username // // optional UserName string `json:"username,omitempty"` // LanguageCode IETF language tag of the user's language // more info: https://en.wikipedia.org/wiki/IETF_language_tag // // optional LanguageCode string `json:"language_code,omitempty"` // CanJoinGroups is true, if the bot can be invited to groups. // Returned only in getMe. // // optional CanJoinGroups bool `json:"can_join_groups,omitempty"` // CanReadAllGroupMessages is true, if privacy mode is disabled for the bot. // Returned only in getMe. // // optional CanReadAllGroupMessages bool `json:"can_read_all_group_messages,omitempty"` // SupportsInlineQueries is true, if the bot supports inline queries. // Returned only in getMe. // // optional SupportsInlineQueries bool `json:"supports_inline_queries,omitempty"` } // String displays a simple text version of a user. // // It is normally a user's username, but falls back to a first/last // name as available. func (u *User) String() string { if u == nil { return "" } if u.UserName != "" { return u.UserName } name := u.FirstName if u.LastName != "" { name += " " + u.LastName } return name } // Chat represents a chat. type Chat struct { // ID is a unique identifier for this chat ID int64 `json:"id"` // Type of chat, can be either “private”, “group”, “supergroup” or “channel” Type string `json:"type"` // Title for supergroups, channels and group chats // // optional Title string `json:"title,omitempty"` // UserName for private chats, supergroups and channels if available // // optional UserName string `json:"username,omitempty"` // FirstName of the other party in a private chat // // optional FirstName string `json:"first_name,omitempty"` // LastName of the other party in a private chat // // optional LastName string `json:"last_name,omitempty"` // Photo is a chat photo Photo *ChatPhoto `json:"photo"` // Bio is the bio of the other party in a private chat. Returned only in // getChat // // optional Bio string `json:"bio,omitempty"` // Description for groups, supergroups and channel chats // // optional Description string `json:"description,omitempty"` // InviteLink is a chat invite link, for groups, supergroups and channel chats. // Each administrator in a chat generates their own invite links, // so the bot must first generate the link using exportChatInviteLink // // optional InviteLink string `json:"invite_link,omitempty"` // PinnedMessage is the pinned message, for groups, supergroups and channels // // optional PinnedMessage *Message `json:"pinned_message,omitempty"` // Permissions is default chat member permissions, for groups and // supergroups. Returned only in getChat. // // optional Permissions *ChatPermissions `json:"permissions,omitempty"` // SlowModeDelay is for supergroups, the minimum allowed delay between // consecutive messages sent by each unpriviledged user. Returned only in // getChat. // // optional SlowModeDelay int `json:"slow_mode_delay,omitempty"` // StickerSetName is for supergroups, name of group sticker set.Returned // only in getChat. // // optional StickerSetName string `json:"sticker_set_name,omitempty"` // CanSetStickerSet is true, if the bot can change the group sticker set. // Returned only in getChat. // // optional CanSetStickerSet bool `json:"can_set_sticker_set,omitempty"` // LinkedChatID is a unique identifier for the linked chat, i.e. the // discussion group identifier for a channel and vice versa; for supergroups // and channel chats. // // optional LinkedChatID int64 `json:"linked_chat_id,omitempty"` // Location is for supergroups, the location to which the supergroup is // connected. Returned only in getChat. // // optional Location *ChatLocation `json:"location"` } // IsPrivate returns if the Chat is a private conversation. func (c Chat) IsPrivate() bool { return c.Type == "private" } // IsGroup returns if the Chat is a group. func (c Chat) IsGroup() bool { return c.Type == "group" } // IsSuperGroup returns if the Chat is a supergroup. func (c Chat) IsSuperGroup() bool { return c.Type == "supergroup" } // IsChannel returns if the Chat is a channel. func (c Chat) IsChannel() bool { return c.Type == "channel" } // ChatConfig returns a ChatConfig struct for chat related methods. func (c Chat) ChatConfig() ChatConfig { return ChatConfig{ChatID: c.ID} } // Message represents a message. type Message struct { // MessageID is a unique message identifier inside this chat MessageID int `json:"message_id"` // From is a sender, empty for messages sent to channels; // // optional From *User `json:"from,omitempty"` // SenderChat is the sender of the message, sent on behalf of a chat. The // channel itself for channel messages. The supergroup itself for messages // from anonymous group administrators. The linked channel for messages // automatically forwarded to the discussion group // // optional SenderChat *Chat `json:"sender_chat,omitempty"` // Date of the message was sent in Unix time Date int `json:"date"` // Chat is the conversation the message belongs to Chat *Chat `json:"chat"` // ForwardFrom for forwarded messages, sender of the original message; // // optional ForwardFrom *User `json:"forward_from,omitempty"` // ForwardFromChat for messages forwarded from channels, // information about the original channel; // // optional ForwardFromChat *Chat `json:"forward_from_chat,omitempty"` // ForwardFromMessageID for messages forwarded from channels, // identifier of the original message in the channel; // // optional ForwardFromMessageID int `json:"forward_from_message_id,omitempty"` // ForwardSignature for messages forwarded from channels, signature of the // post author if present // // optional ForwardSignature string `json:"forward_signature,omitempty"` // ForwardSenderName is the sender's name for messages forwarded from users // who disallow adding a link to their account in forwarded messages // // optional ForwardSenderName string `json:"forward_sender_name,omitempty"` // ForwardDate for forwarded messages, date the original message was sent in Unix time; // // optional ForwardDate int `json:"forward_date,omitempty"` // ReplyToMessage for replies, the original message. // Note that the Message object in this field will not contain further ReplyToMessage fields // even if it itself is a reply; // // optional ReplyToMessage *Message `json:"reply_to_message,omitempty"` // ViaBot through which the message was sent; // // optional ViaBot *User `json:"via_bot,omitempty"` // EditDate of the message was last edited in Unix time; // // optional EditDate int `json:"edit_date,omitempty"` // MediaGroupID is the unique identifier of a media message group this message belongs to; // // optional MediaGroupID string `json:"media_group_id,omitempty"` // AuthorSignature is the signature of the post author for messages in channels; // // optional AuthorSignature string `json:"author_signature,omitempty"` // Text is for text messages, the actual UTF-8 text of the message, 0-4096 characters; // // optional Text string `json:"text,omitempty"` // Entities is for text messages, special entities like usernames, // URLs, bot commands, etc. that appear in the text; // // optional Entities []MessageEntity `json:"entities,omitempty"` // Animation message is an animation, information about the animation. // For backward compatibility, when this field is set, the document field will also be set; // // optional Animation *Animation `json:"animation,omitempty"` // Audio message is an audio file, information about the file; // // optional Audio *Audio `json:"audio,omitempty"` // Document message is a general file, information about the file; // // optional Document *Document `json:"document,omitempty"` // Photo message is a photo, available sizes of the photo; // // optional Photo []PhotoSize `json:"photo,omitempty"` // Sticker message is a sticker, information about the sticker; // // optional Sticker *Sticker `json:"sticker,omitempty"` // Video message is a video, information about the video; // // optional Video *Video `json:"video,omitempty"` // VideoNote message is a video note, information about the video message; // // optional VideoNote *VideoNote `json:"video_note,omitempty"` // Voice message is a voice message, information about the file; // // optional Voice *Voice `json:"voice,omitempty"` // Caption for the animation, audio, document, photo, video or voice, 0-1024 characters; // // optional Caption string `json:"caption,omitempty"` // CaptionEntities; // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Contact message is a shared contact, information about the contact; // // optional Contact *Contact `json:"contact,omitempty"` // Dice is a dice with random value; // // optional Dice *Dice `json:"dice,omitempty"` // Game message is a game, information about the game; // // optional Game *Game `json:"game,omitempty"` // Poll is a native poll, information about the poll; // // optional Poll *Poll `json:"poll,omitempty"` // Venue message is a venue, information about the venue. // For backward compatibility, when this field is set, the location field // will also be set; // // optional Venue *Venue `json:"venue,omitempty"` // Location message is a shared location, information about the location; // // optional Location *Location `json:"location,omitempty"` // NewChatMembers that were added to the group or supergroup // and information about them (the bot itself may be one of these members); // // optional NewChatMembers []User `json:"new_chat_members,omitempty"` // LeftChatMember is a member was removed from the group, // information about them (this member may be the bot itself); // // optional LeftChatMember *User `json:"left_chat_member,omitempty"` // NewChatTitle is a chat title was changed to this value; // // optional NewChatTitle string `json:"new_chat_title,omitempty"` // NewChatPhoto is a chat photo was change to this value; // // optional NewChatPhoto []PhotoSize `json:"new_chat_photo,omitempty"` // DeleteChatPhoto is a service message: the chat photo was deleted; // // optional DeleteChatPhoto bool `json:"delete_chat_photo,omitempty"` // GroupChatCreated is a service message: the group has been created; // // optional GroupChatCreated bool `json:"group_chat_created,omitempty"` // SuperGroupChatCreated is a 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 ReplyToMessage if someone replies to a very first message // in a directly created supergroup; // // optional SuperGroupChatCreated bool `json:"supergroup_chat_created,omitempty"` // ChannelChatCreated is a 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 ReplyToMessage // if someone replies to a very first message in a channel; // // optional ChannelChatCreated bool `json:"channel_chat_created,omitempty"` // MessageAutoDeleteTimerChanged is a service message: auto-delete timer // settings changed in the chat. // // optional MessageAutoDeleteTimerChanged *MessageAutoDeleteTimerChanged `json:"message_auto_delete_timer_changed"` // MigrateToChatID is the group has been migrated to a supergroup with the specified identifier. // This number may be greater than 32 bits and some programming languages // may have difficulty/silent defects in interpreting it. // But it is smaller than 52 bits, so a signed 64 bit integer // or double-precision float type are safe for storing this identifier; // // optional MigrateToChatID int64 `json:"migrate_to_chat_id,omitempty"` // MigrateFromChatID is the supergroup has been migrated from a group with the specified identifier. // This number may be greater than 32 bits and some programming languages // may have difficulty/silent defects in interpreting it. // But it is smaller than 52 bits, so a signed 64 bit integer // or double-precision float type are safe for storing this identifier; // // optional MigrateFromChatID int64 `json:"migrate_from_chat_id,omitempty"` // PinnedMessage is a specified message was pinned. // Note that the Message object in this field will not contain further ReplyToMessage // fields even if it is itself a reply; // // optional PinnedMessage *Message `json:"pinned_message,omitempty"` // Invoice message is an invoice for a payment; // // optional Invoice *Invoice `json:"invoice,omitempty"` // SuccessfulPayment message is a service message about a successful payment, // information about the payment; // // optional SuccessfulPayment *SuccessfulPayment `json:"successful_payment,omitempty"` // ConnectedWebsite is Tthe domain name of the website on which the user has // logged in; // // optional ConnectedWebsite string `json:"connected_website,omitempty"` // PassportData is a Telegram Passport data; // // optional PassportData *PassportData `json:"passport_data,omitempty"` // ProximityAlertTriggered is a service message. A user in the chat // triggered another user's proximity alert while sharing Live Location // // optional ProximityAlertTriggered *ProximityAlertTriggered `json:"proximity_alert_triggered"` // VoiceChatScheduled is a service message: voice chat scheduled. // // optional VoiceChatScheduled *VoiceChatScheduled `json:"voice_chat_scheduled"` // VoiceChatStarted is a service message: voice chat started. // // optional VoiceChatStarted *VoiceChatStarted `json:"voice_chat_started"` // VoiceChatEnded is a service message: voice chat ended. // // optional VoiceChatEnded *VoiceChatEnded `json:"voice_chat_ended"` // VoiceChatParticipantsInvited is a service message: new participants // invited to a voice chat. // // optional VoiceChatParticipantsInvited *VoiceChatParticipantsInvited `json:"voice_chat_participants_invited"` // ReplyMarkup is the Inline keyboard attached to the message. // login_url buttons are represented as ordinary url buttons. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` } // Time converts the message timestamp into a Time. func (m *Message) Time() time.Time { return time.Unix(int64(m.Date), 0) } // IsCommand returns true if message starts with a "bot_command" entity. func (m *Message) IsCommand() bool { if m.Entities == nil || len(m.Entities) == 0 { return false } entity := m.Entities[0] return entity.Offset == 0 && entity.IsCommand() } // Command checks if the message was a command and if it was, returns the // command. If the Message was not a command, it returns an empty string. // // If the command contains the at name syntax, it is removed. Use // CommandWithAt() if you do not want that. func (m *Message) Command() string { command := m.CommandWithAt() if i := strings.Index(command, "@"); i != -1 { command = command[:i] } return command } // CommandWithAt checks if the message was a command and if it was, returns the // command. If the Message was not a command, it returns an empty string. // // If the command contains the at name syntax, it is not removed. Use Command() // if you want that. func (m *Message) CommandWithAt() string { if !m.IsCommand() { return "" } // IsCommand() checks that the message begins with a bot_command entity entity := m.Entities[0] return m.Text[1:entity.Length] } // CommandArguments checks if the message was a command and if it was, // returns all text after the command name. If the Message was not a // command, it returns an empty string. // // Note: The first character after the command name is omitted: // - "/foo bar baz" yields "bar baz", not " bar baz" // - "/foo-bar baz" yields "bar baz", too // Even though the latter is not a command conforming to the spec, the API // marks "/foo" as command entity. func (m *Message) CommandArguments() string { if !m.IsCommand() { return "" } // IsCommand() checks that the message begins with a bot_command entity entity := m.Entities[0] if len(m.Text) == entity.Length { return "" // The command makes up the whole message } return m.Text[entity.Length+1:] } // MessageID represents a unique message identifier. type MessageID struct { MessageID int `json:"message_id"` } // MessageEntity represents one special entity in a text message. type MessageEntity struct { // Type of the entity. // Can be: // “mention” (@username), // “hashtag” (#hashtag), // “cashtag” ($USD), // “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), // “code” (monowidth string), // “pre” (monowidth block), // “text_link” (for clickable text URLs), // “text_mention” (for users without usernames) Type string `json:"type"` // Offset in UTF-16 code units to the start of the entity Offset int `json:"offset"` // Length Length int `json:"length"` // URL for “text_link” only, url that will be opened after user taps on the text // // optional URL string `json:"url,omitempty"` // User for “text_mention” only, the mentioned user // // optional User *User `json:"user,omitempty"` // Language for “pre” only, the programming language of the entity text // // optional Language string `json:"language,omitempty"` } // ParseURL attempts to parse a URL contained within a MessageEntity. func (e MessageEntity) ParseURL() (*url.URL, error) { if e.URL == "" { return nil, errors.New(ErrBadURL) } return url.Parse(e.URL) } // IsMention returns true if the type of the message entity is "mention" (@username). func (e MessageEntity) IsMention() bool { return e.Type == "mention" } // IsHashtag returns true if the type of the message entity is "hashtag". func (e MessageEntity) IsHashtag() bool { return e.Type == "hashtag" } // IsCommand returns true if the type of the message entity is "bot_command". func (e MessageEntity) IsCommand() bool { return e.Type == "bot_command" } // IsURL returns true if the type of the message entity is "url". func (e MessageEntity) IsURL() bool { return e.Type == "url" } // IsEmail returns true if the type of the message entity is "email". func (e MessageEntity) IsEmail() bool { return e.Type == "email" } // IsBold returns true if the type of the message entity is "bold" (bold text). func (e MessageEntity) IsBold() bool { return e.Type == "bold" } // IsItalic returns true if the type of the message entity is "italic" (italic text). func (e MessageEntity) IsItalic() bool { return e.Type == "italic" } // IsCode returns true if the type of the message entity is "code" (monowidth string). func (e MessageEntity) IsCode() bool { return e.Type == "code" } // IsPre returns true if the type of the message entity is "pre" (monowidth block). func (e MessageEntity) IsPre() bool { return e.Type == "pre" } // IsTextLink returns true if the type of the message entity is "text_link" (clickable text URL). func (e MessageEntity) IsTextLink() bool { return e.Type == "text_link" } // PhotoSize represents one size of a photo or a file / sticker thumbnail. type PhotoSize struct { // FileID identifier for this file, which can be used to download or reuse // the file FileID string `json:"file_id"` // FileUniqueID is the 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"` // Width photo width Width int `json:"width"` // Height photo height Height int `json:"height"` // FileSize file size // // optional FileSize int `json:"file_size,omitempty"` } // Animation represents an animation file. type Animation struct { // FileID odentifier for this file, which can be used to download or reuse // the file FileID string `json:"file_id"` // FileUniqueID is the 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"` // Width video width as defined by sender Width int `json:"width"` // Height video height as defined by sender Height int `json:"height"` // Duration of the video in seconds as defined by sender Duration int `json:"duration"` // Thumbnail animation thumbnail as defined by sender // // optional Thumbnail *PhotoSize `json:"thumb,omitempty"` // FileName original animation filename as defined by sender // // optional FileName string `json:"file_name,omitempty"` // MimeType of the file as defined by sender // // optional MimeType string `json:"mime_type,omitempty"` // FileSize file size // // optional FileSize int `json:"file_size,omitempty"` } // Audio represents an audio file to be treated as music by the Telegram clients. type Audio struct { // FileID is an identifier for this file, which can be used to download or // reuse the file FileID string `json:"file_id"` // FileUniqueID is the 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 sender Duration int `json:"duration"` // Performer of the audio as defined by sender or by audio tags // // optional Performer string `json:"performer,omitempty"` // Title of the audio as defined by sender or by audio tags // // optional Title string `json:"title,omitempty"` // FileName is the original filename as defined by sender // // optional FileName string `json:"file_name,omitempty"` // MimeType of the file as defined by sender // // optional MimeType string `json:"mime_type,omitempty"` // FileSize file size // // optional FileSize int `json:"file_size,omitempty"` // Thumbnail is the album cover to which the music file belongs // // optional Thumbnail *PhotoSize `json:"thumb,omitempty"` } // Document represents a general file. type Document struct { // FileID is a identifier for this file, which can be used to download or // reuse the file FileID string `json:"file_id"` // FileUniqueID is the 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"` // Thumbnail document thumbnail as defined by sender // // optional Thumbnail *PhotoSize `json:"thumb,omitempty"` // FileName original filename as defined by sender // // optional FileName string `json:"file_name,omitempty"` // MimeType of the file as defined by sender // // optional MimeType string `json:"mime_type,omitempty"` // FileSize file size // // optional FileSize int `json:"file_size,omitempty"` } // Video represents a video file. type Video struct { // FileID identifier for this file, which can be used to download or reuse // the file FileID string `json:"file_id"` // FileUniqueID is the 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"` // Width video width as defined by sender Width int `json:"width"` // Height video height as defined by sender Height int `json:"height"` // Duration of the video in seconds as defined by sender Duration int `json:"duration"` // Thumbnail video thumbnail // // optional Thumbnail *PhotoSize `json:"thumb,omitempty"` // FileName is the original filename as defined by sender // // optional FileName string `json:"file_name,omitempty"` // MimeType of a file as defined by sender // // optional MimeType string `json:"mime_type,omitempty"` // FileSize file size // // optional FileSize int `json:"file_size,omitempty"` } // VideoNote object represents a video message. type VideoNote struct { // FileID identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID is the 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"` // Length video width and height (diameter of the video message) as defined by sender Length int `json:"length"` // Duration of the video in seconds as defined by sender Duration int `json:"duration"` // Thumbnail video thumbnail // // optional Thumbnail *PhotoSize `json:"thumb,omitempty"` // FileSize file size // // optional FileSize int `json:"file_size,omitempty"` } // Voice represents a voice note. type Voice struct { // FileID identifier for this file, which can be used to download or reuse the file FileID string `json:"file_id"` // FileUniqueID is the 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 sender Duration int `json:"duration"` // MimeType of the file as defined by sender // // optional MimeType string `json:"mime_type,omitempty"` // FileSize file size // // optional FileSize int `json:"file_size,omitempty"` } // Contact represents a phone contact. // // Note that LastName and UserID may be empty. type Contact struct { // PhoneNumber contact's phone number PhoneNumber string `json:"phone_number"` // FirstName contact's first name FirstName string `json:"first_name"` // LastName contact's last name // // optional LastName string `json:"last_name,omitempty"` // UserID contact's user identifier in Telegram // // optional UserID int64 `json:"user_id,omitempty"` // VCard is additional data about the contact in the form of a vCard. // // optional VCard string `json:"vcard,omitempty"` } // Dice 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 Value int `json:"value"` } // PollOption contains information about one answer option in a poll. type PollOption struct { // Text is the option text, 1-100 characters Text string `json:"text"` // VoterCount is the number of users that voted for this option VoterCount int `json:"voter_count"` } // PollAnswer represents an answer of a user in a non-anonymous poll. type PollAnswer struct { // PollID is the unique poll identifier PollID string `json:"poll_id"` // User who changed the answer to the poll User User `json:"user"` // OptionIDs is the 0-based identifiers of poll options chosen by the user. // May be empty if user retracted vote. OptionIDs []int `json:"option_ids"` } // Poll contains information about a poll. type Poll struct { // ID is the unique poll identifier ID string `json:"id"` // Question is the poll question, 1-255 characters Question string `json:"question"` // Options is the list of poll options Options []PollOption `json:"options"` // TotalVoterCount is the total numbers of users who voted in the poll TotalVoterCount int `json:"total_voter_count"` // IsClosed is if the poll is closed IsClosed bool `json:"is_closed"` // IsAnonymous is if the poll is anonymous IsAnonymous bool `json:"is_anonymous"` // Type is the poll type, currently can be "regular" or "quiz" Type string `json:"type"` // AllowsMultipleAnswers is true, if the poll allows multiple answers AllowsMultipleAnswers bool `json:"allows_multiple_answers"` // CorrectOptionID is the 0-based identifier of the correct answer option. // Available only for polls in quiz mode, which are closed, or was sent (not // forwarded) by the bot or to the private chat with the bot. // // optional CorrectOptionID int `json:"correct_option_id,omitempty"` // Explanation is 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 // // optional Explanation string `json:"explanation,omitempty"` // ExplainationEntities are special entities like usernames, URLs, bot // commands, etc. that appear in the explanation // // optional ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"` // OpenPeriod is the amount of time in seconds the poll will be active // after creation // // optional OpenPeriod int `json:"open_period,omitempty"` // Closedate is the point in time (unix timestamp) when the poll will be // automatically closed // // optional CloseDate int `json:"close_date,omitempty"` } // Location represents a point on the map. type Location struct { // Longitude as defined by sender Longitude float64 `json:"longitude"` // Latitude as defined by sender Latitude float64 `json:"latitude"` // HorizontalAccuracy is the radius of uncertainty for the location, // measured in meters; 0-1500 // // optional HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"` // LivePeriod is time relative to the message sending date, during which the // location can be updated, in seconds. For active live locations only. // // optional LivePeriod int `json:"live_period,omitempty"` // Heading is the direction in which user is moving, in degrees; 1-360. For // active live locations only. // // optional Heading int `json:"heading,omitempty"` // ProximityAlertRadius is the maximum distance for proximity alerts about // approaching another chat member, in meters. For sent live locations only. // // optional ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"` } // Venue represents a venue. type Venue struct { // Location is the venue location Location Location `json:"location"` // Title is the name of the venue Title string `json:"title"` // Address of the venue Address string `json:"address"` // FoursquareID is the foursquare identifier of the venue // // optional FoursquareID string `json:"foursquare_id,omitempty"` // FoursquareType is the foursquare type of the venue // // optional FoursquareType string `json:"foursquare_type,omitempty"` // GooglePlaceID is the Google Places identifier of the venue // // optional GooglePlaceID string `json:"google_place_id,omitempty"` // GooglePlaceType is the Google Places type of the venue // // optional GooglePlaceType string `json:"google_place_type,omitempty"` } // ProximityAlertTriggered represents a service message sent when a user in the // chat triggers a proximity alert sent by another user. type ProximityAlertTriggered struct { // Traveler is the user that triggered the alert Traveler User `json:"traveler"` // Watcher is the user that set the alert Watcher User `json:"watcher"` // Distance is the distance between the users Distance int `json:"distance"` } // MessageAutoDeleteTimerChanged represents a service message about a change in // auto-delete timer settings. type MessageAutoDeleteTimerChanged struct { // New auto-delete time for messages in the chat. MessageAutoDeleteTime int `json:"message_auto_delete_time"` } // VoiceChatScheduled represents a service message about a voice chat scheduled // in the chat. type VoiceChatScheduled struct { // Point in time (Unix timestamp) when the voice chat is supposed to be // started by a chat administrator StartDate int `json:"start_date"` } // Time converts the scheduled start date into a Time. func (m *VoiceChatScheduled) Time() time.Time { return time.Unix(int64(m.StartDate), 0) } // VoiceChatStarted represents a service message about a voice chat started in // the chat. type VoiceChatStarted struct{} // VoiceChatEnded represents a service message about a voice chat ended in the // chat. type VoiceChatEnded struct { // Voice chat duration; in seconds. Duration int `json:"duration"` } // VoiceChatParticipantsInvited represents a service message about new members // invited to a voice chat. type VoiceChatParticipantsInvited struct { // New members that were invited to the voice chat. // // optional Users []User `json:"users"` } // UserProfilePhotos contains a set of user profile photos. type UserProfilePhotos struct { // TotalCount total number of profile pictures the target user has TotalCount int `json:"total_count"` // Photos requested profile pictures (in up to 4 sizes each) Photos [][]PhotoSize `json:"photos"` } // File contains information about a file to download from Telegram. type File struct { // FileID identifier for this file, which can be used to download or reuse // the file FileID string `json:"file_id"` // FileUniqueID is the 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"` // FileSize file size, if known // // optional FileSize int `json:"file_size,omitempty"` // FilePath file path // // optional FilePath string `json:"file_path,omitempty"` } // Link returns a full path to the download URL for a File. // // It requires the Bot token to create the link. func (f *File) Link(token string) string { return fmt.Sprintf(FileEndpoint, token, f.FilePath) } // ReplyKeyboardMarkup represents a custom keyboard with reply options. type ReplyKeyboardMarkup struct { // Keyboard is an array of button rows, each represented by an Array of KeyboardButton objects Keyboard [][]KeyboardButton `json:"keyboard"` // ResizeKeyboard 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. // // optional ResizeKeyboard bool `json:"resize_keyboard,omitempty"` // OneTimeKeyboard 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. // // optional OneTimeKeyboard bool `json:"one_time_keyboard,omitempty"` // InputFieldPlaceholder is the placeholder to be shown in the input field when // the keyboard is active; 1-64 characters. // // optional InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"` // Selective use this parameter if you want to show the keyboard to specific users only. // Targets: // 1) users that are @mentioned in the text of the Message object; // 2) if the bot's message is a reply (has Message.ReplyToMessage not nil), 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. // // optional Selective bool `json:"selective,omitempty"` } // KeyboardButton represents one button of the reply keyboard. For simple text // buttons String can be used instead of this object to specify text of the // button. Optional fields request_contact, request_location, and request_poll // are mutually exclusive. type KeyboardButton struct { // Text of the button. If none of the optional fields are used, // it will be sent as a message when the button is pressed. Text string `json:"text"` // RequestContact if True, the user's phone number will be sent // as a contact when the button is pressed. // Available in private chats only. // // optional RequestContact bool `json:"request_contact,omitempty"` // RequestLocation if True, the user's current location will be sent when // the button is pressed. // Available in private chats only. // // optional RequestLocation bool `json:"request_location,omitempty"` // RequestPoll if True, 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 // // optional RequestPoll *KeyboardButtonPollType `json:"request_poll,omitempty"` } // KeyboardButtonPollType represents type of a poll, which is allowed to // be created and sent when the corresponding button is pressed. type KeyboardButtonPollType struct { // Type is 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"` } // ReplyKeyboardRemove Upon receiving a message with this object, Telegram // clients will remove the current custom keyboard and display the default // letter-keyboard. By default, custom keyboards are displayed until a new // keyboard is sent by a bot. An exception is made for one-time keyboards // that are hidden immediately after the user presses a button. type ReplyKeyboardRemove struct { // RemoveKeyboard 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"` // Selective use this parameter if you want to remove the keyboard for specific users only. // Targets: // 1) users that are @mentioned in the text of the Message object; // 2) if the bot's message is a reply (has Message.ReplyToMessage not nil), 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. // // optional Selective bool `json:"selective,omitempty"` } // InlineKeyboardMarkup represents an inline keyboard that appears right next to // the message it belongs to. type InlineKeyboardMarkup struct { // InlineKeyboard array of button rows, each represented by an Array of // InlineKeyboardButton objects InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"` } // InlineKeyboardButton represents one button of an inline keyboard. You must // use exactly one of the optional fields. // // Note that some values are references as even an empty string // will change behavior. // // CallbackGame, if set, MUST be first button in first row. type InlineKeyboardButton struct { // Text label text on the button Text string `json:"text"` // URL HTTP or tg:// url to be opened when button is pressed. // // optional URL *string `json:"url,omitempty"` // LoginURL is an HTTP URL used to automatically authorize the user. Can be // used as a replacement for the Telegram Login Widget // // optional LoginURL *LoginURL `json:"login_url,omitempty"` // CallbackData data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. // // optional CallbackData *string `json:"callback_data,omitempty"` // SwitchInlineQuery if set, pressing the button will prompt the user to select one of their chats, // open that chat and insert the bot's username and the specified inline query in the input field. // Can be empty, in which case just the bot's username will be inserted. // // This offers an easy way for users to start using your bot // in inline mode when they are currently in a private chat with it. // Especially useful when combined with switch_pm… actions – in this case // the user will be automatically returned to the chat they switched from, // skipping the chat selection screen. // // optional SwitchInlineQuery *string `json:"switch_inline_query,omitempty"` // SwitchInlineQueryCurrentChat if set, pressing the button will insert the bot's username // and the specified inline query in the current chat's input field. // Can be empty, in which case only the bot's username will be inserted. // // 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. // // optional SwitchInlineQueryCurrentChat *string `json:"switch_inline_query_current_chat,omitempty"` // CallbackGame description of the game that will be launched when the user presses the button. // // optional CallbackGame *CallbackGame `json:"callback_game,omitempty"` // Pay specify True, to send a Pay button. // // NOTE: This type of button must always be the first button in the first row. // // optional Pay bool `json:"pay,omitempty"` } // LoginURL 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. type LoginURL struct { // URL is an HTTP URL to be opened with user authorization data added to the // query string when the button is pressed. If the user refuses to provide // authorization data, the original URL without information about the user // will be opened. The data added is the same as described in Receiving // authorization data. // // 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"` // ForwardText is the new text of the button in forwarded messages // // optional ForwardText string `json:"forward_text,omitempty"` // BotUsername is the 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. // // optional BotUsername string `json:"bot_username,omitempty"` // RequestWriteAccess if true requests permission for your bot to send // messages to the user // // optional RequestWriteAccess bool `json:"request_write_access,omitempty"` } // CallbackQuery 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. type CallbackQuery struct { // ID unique identifier for this query ID string `json:"id"` // From sender From *User `json:"from"` // Message with the callback button that originated the query. // Note that message content and message date will not be available if the // message is too old. // // optional Message *Message `json:"message,omitempty"` // InlineMessageID identifier of the message sent via the bot in inline // mode, that originated the query. // // optional InlineMessageID string `json:"inline_message_id,omitempty"` // ChatInstance 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"` // Data associated with the callback button. Be aware that // a bad client can send arbitrary data in this field. // // optional Data string `json:"data,omitempty"` // GameShortName short name of a Game to be returned, serves as the unique identifier for the game. // // optional GameShortName string `json:"game_short_name,omitempty"` } // ForceReply when 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. type ForceReply struct { // ForceReply shows reply interface to the user, // as if they manually selected the bot's message and tapped 'Reply'. ForceReply bool `json:"force_reply"` // InputFieldPlaceholder is the placeholder to be shown in the input field when // the reply is active; 1-64 characters. // // optional InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"` // Selective use this parameter if you want to force reply from specific users only. // Targets: // 1) users that are @mentioned in the text of the Message object; // 2) if the bot's message is a reply (has Message.ReplyToMessage not nil), sender of the original message. // // optional Selective bool `json:"selective,omitempty"` } // ChatPhoto represents a chat photo. type ChatPhoto struct { // SmallFileID is a 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"` // SmallFileUniqueID is a 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"` // BigFileID is a 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"` // BigFileUniqueID is a 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"` } // ChatInviteLink represents an invite link for a chat. type ChatInviteLink struct { // InviteLink is 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"` // CreatesJoinRequest is true if users joining the chat via the link need to // be approved by chat administrators. // // optional CreatesJoinRequest bool `json:"creates_join_request"` // IsPrimary is true, if the link is primary. IsPrimary bool `json:"is_primary"` // IsRevoked is true, if the link is revoked. IsRevoked bool `json:"is_revoked"` // Name is the name of the invite link. // // optional Name string `json:"name"` // ExpireDate is the point in time (Unix timestamp) when the link will // expire or has been expired. // // optional ExpireDate int `json:"expire_date"` // MemberLimit is the maximum number of users that can be members of the // chat simultaneously after joining the chat via this invite link; 1-99999. // // optional MemberLimit int `json:"member_limit"` // PendingJoinRequestCount is the number of pending join requests created // using this link. // // optional PendingJoinRequestCount int `json:"pending_join_request_count"` } // ChatMember contains information about one member of a chat. type ChatMember struct { // User information about the user User *User `json:"user"` // Status the member's status in the chat. // Can be // “creator”, // “administrator”, // “member”, // “restricted”, // “left” or // “kicked” Status string `json:"status"` // CustomTitle owner and administrators only. Custom title for this user // // optional CustomTitle string `json:"custom_title,omitempty"` // IsAnonymous owner and administrators only. True, if the user's presence // in the chat is hidden // // optional IsAnonymous bool `json:"is_anonymous"` // UntilDate restricted and kicked only. // Date when restrictions will be lifted for this user; // unix time. // // optional UntilDate int64 `json:"until_date,omitempty"` // CanBeEdited administrators only. // True, if the bot is allowed to edit administrator privileges of that user. // // optional CanBeEdited bool `json:"can_be_edited,omitempty"` // CanManageChat administrators only. // True, if the administrator can access the chat event log, chat // statistics, message statistics in channels, see channel members, see // anonymous administrators in supergoups and ignore slow mode. Implied by // any other administrator privilege. // // optional CanManageChat bool `json:"can_manage_chat"` // CanPostMessages administrators only. // True, if the administrator can post in the channel; // channels only. // // optional CanPostMessages bool `json:"can_post_messages,omitempty"` // CanEditMessages administrators only. // True, if the administrator can edit messages of other users and can pin messages; // channels only. // // optional CanEditMessages bool `json:"can_edit_messages,omitempty"` // CanDeleteMessages administrators only. // True, if the administrator can delete messages of other users. // // optional CanDeleteMessages bool `json:"can_delete_messages,omitempty"` // CanManageVoiceChats administrators only. // True, if the administrator can manage voice chats. // // optional CanManageVoiceChats bool `json:"can_manage_voice_chats"` // CanRestrictMembers administrators only. // True, if the administrator can restrict, ban or unban chat members. // // optional CanRestrictMembers bool `json:"can_restrict_members,omitempty"` // CanPromoteMembers administrators only. // True, if the administrator can add new administrators // with a subset of their own privileges or demote administrators that he has promoted, // directly or indirectly (promoted by administrators that were appointed by the user). // // optional CanPromoteMembers bool `json:"can_promote_members,omitempty"` // CanChangeInfo administrators and restricted only. // True, if the user is allowed to change the chat title, photo and other settings. // // optional CanChangeInfo bool `json:"can_change_info,omitempty"` // CanInviteUsers administrators and restricted only. // True, if the user is allowed to invite new users to the chat. // // optional CanInviteUsers bool `json:"can_invite_users,omitempty"` // CanPinMessages administrators and restricted only. // True, if the user is allowed to pin messages; groups and supergroups only // // optional CanPinMessages bool `json:"can_pin_messages,omitempty"` // IsMember is true, if the user is a member of the chat at the moment of // the request IsMember bool `json:"is_member"` // CanSendMessages // // optional CanSendMessages bool `json:"can_send_messages,omitempty"` // CanSendMediaMessages restricted only. // True, if the user is allowed to send text messages, contacts, locations and venues // // optional CanSendMediaMessages bool `json:"can_send_media_messages,omitempty"` // CanSendPolls restricted only. // True, if the user is allowed to send polls // // optional CanSendPolls bool `json:"can_send_polls,omitempty"` // CanSendOtherMessages restricted only. // True, if the user is allowed to send audios, documents, // photos, videos, video notes and voice notes. // // optional CanSendOtherMessages bool `json:"can_send_other_messages,omitempty"` // CanAddWebPagePreviews restricted only. // True, if the user is allowed to add web page previews to their messages. // // optional CanAddWebPagePreviews bool `json:"can_add_web_page_previews,omitempty"` } // IsCreator returns if the ChatMember was the creator of the chat. func (chat ChatMember) IsCreator() bool { return chat.Status == "creator" } // IsAdministrator returns if the ChatMember is a chat administrator. func (chat ChatMember) IsAdministrator() bool { return chat.Status == "administrator" } // HasLeft returns if the ChatMember left the chat. func (chat ChatMember) HasLeft() bool { return chat.Status == "left" } // WasKicked returns if the ChatMember was kicked from the chat. func (chat ChatMember) WasKicked() bool { return chat.Status == "kicked" } // ChatMemberUpdated represents changes in the status of a chat member. type ChatMemberUpdated struct { // Chat the user belongs to. Chat Chat `json:"chat"` // From is the performer of the action, which resulted in the change. From User `json:"from"` // Date the change was done in Unix time. Date int `json:"date"` // Previous information about the chat member. OldChatMember ChatMember `json:"old_chat_member"` // New information about the chat member. NewChatMember ChatMember `json:"new_chat_member"` // InviteLink is the link which was used by the user to join the chat; // for joining by invite link events only. // // optional InviteLink *ChatInviteLink `json:"invite_link"` } // ChatJoinRequest 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:"user"` // Date the request was sent in Unix time. Date int `json:"date"` // Bio of the user. // // optional Bio string `json:"bio"` // InviteLink is the link that was used by the user to send the join request. // // optional InviteLink *ChatInviteLink `json:"invite_link"` } // ChatPermissions describes actions that a non-administrator user is // allowed to take in a chat. All fields are optional. type ChatPermissions struct { // CanSendMessages is true, if the user is allowed to send text messages, // contacts, locations and venues // // optional CanSendMessages bool `json:"can_send_messages,omitempty"` // CanSendMediaMessages is true, if the user is allowed to send audios, // documents, photos, videos, video notes and voice notes, implies // can_send_messages // // optional CanSendMediaMessages bool `json:"can_send_media_messages,omitempty"` // CanSendPolls is true, if the user is allowed to send polls, implies // can_send_messages // // optional CanSendPolls bool `json:"can_send_polls,omitempty"` // CanSendOtherMessages is true, if the user is allowed to send animations, // games, stickers and use inline bots, implies can_send_media_messages // // optional CanSendOtherMessages bool `json:"can_send_other_messages,omitempty"` // CanAddWebPagePreviews is true, if the user is allowed to add web page // previews to their messages, implies can_send_media_messages // // optional CanAddWebPagePreviews bool `json:"can_add_web_page_previews,omitempty"` // CanChangeInfo is true, if the user is allowed to change the chat title, // photo and other settings. Ignored in public supergroups // // optional CanChangeInfo bool `json:"can_change_info,omitempty"` // CanInviteUsers is true, if the user is allowed to invite new users to the // chat // // optional CanInviteUsers bool `json:"can_invite_users,omitempty"` // CanPinMessages is true, if the user is allowed to pin messages. Ignored // in public supergroups // // optional CanPinMessages bool `json:"can_pin_messages,omitempty"` } // ChatLocation represents a location to which a chat is connected. type ChatLocation struct { // Location is the location to which the supergroup is connected. Can't be a // live location. Location Location `json:"location"` // Address is the location address; 1-64 characters, as defined by the chat // owner Address string `json:"address"` } // BotCommand represents a bot command. type BotCommand struct { // Command text of the command, 1-32 characters. // Can contain only lowercase English letters, digits and underscores. Command string `json:"command"` // Description of the command, 3-256 characters. Description string `json:"description"` } // BotCommandScope represents the scope to which bot commands are applied. // // It contains the fields for all types of scopes, different types only support // specific (or no) fields. type BotCommandScope struct { Type string `json:"type"` ChatID int64 `json:"chat_id,omitempty"` UserID int64 `json:"user_id,omitempty"` } // ResponseParameters are various errors that can be returned in APIResponse. type ResponseParameters struct { // The group has been migrated to a supergroup with the specified identifier. // // optional MigrateToChatID int64 `json:"migrate_to_chat_id,omitempty"` // In case of exceeding flood control, the number of seconds left to wait // before the request can be repeated. // // optional RetryAfter int `json:"retry_after,omitempty"` } // BaseInputMedia is a base type for the InputMedia types. type BaseInputMedia struct { // Type of the result. Type string `json:"type"` // Media file to send. Pass a file_id to send a file // that exists on the Telegram servers (recommended), // pass an HTTP URL for Telegram to get a file from the Internet, // or pass “attach://” to upload a new one // using multipart/form-data under name. Media interface{} `json:"media"` // thumb intentionally missing as it is not currently compatible // Caption of the video to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities"` } // InputMediaPhoto is a photo to send as part of a media group. type InputMediaPhoto struct { BaseInputMedia } // InputMediaVideo is a video to send as part of a media group. type InputMediaVideo struct { BaseInputMedia // Thumbnail of the file sent; can be ignored if thumbnail generation for // the file is supported server-side. // // optional Thumb interface{} `json:"thumb,omitempty"` // Width video width // // optional Width int `json:"width,omitempty"` // Height video height // // optional Height int `json:"height,omitempty"` // Duration video duration // // optional Duration int `json:"duration,omitempty"` // SupportsStreaming pass True, if the uploaded video is suitable for streaming. // // optional SupportsStreaming bool `json:"supports_streaming,omitempty"` } // InputMediaAnimation is an animation to send as part of a media group. type InputMediaAnimation struct { BaseInputMedia // Thumbnail of the file sent; can be ignored if thumbnail generation for // the file is supported server-side. // // optional Thumb interface{} `json:"thumb,omitempty"` // Width video width // // optional Width int `json:"width,omitempty"` // Height video height // // optional Height int `json:"height,omitempty"` // Duration video duration // // optional Duration int `json:"duration,omitempty"` } // InputMediaAudio is a audio to send as part of a media group. type InputMediaAudio struct { BaseInputMedia // Thumbnail of the file sent; can be ignored if thumbnail generation for // the file is supported server-side. // // optional Thumb interface{} `json:"thumb,omitempty"` // Duration of the audio in seconds // // optional Duration int `json:"duration,omitempty"` // Performer of the audio // // optional Performer string `json:"performer,omitempty"` // Title of the audio // // optional Title string `json:"title,omitempty"` } // InputMediaDocument is a general file to send as part of a media group. type InputMediaDocument struct { BaseInputMedia // Thumbnail of the file sent; can be ignored if thumbnail generation for // the file is supported server-side. // // optional Thumb interface{} `json:"thumb,omitempty"` // DisableContentTypeDetection 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 // // optional DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"` } // Sticker represents a sticker. type Sticker struct { // FileID is an identifier for this file, which can be used to download or // reuse the file FileID string `json:"file_id"` // FileUniqueID is an 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"` // Width sticker width Width int `json:"width"` // Height sticker height Height int `json:"height"` // IsAnimated true, if the sticker is animated // // optional IsAnimated bool `json:"is_animated,omitempty"` // Thumbnail sticker thumbnail in the .WEBP or .JPG format // // optional Thumbnail *PhotoSize `json:"thumb,omitempty"` // Emoji associated with the sticker // // optional Emoji string `json:"emoji,omitempty"` // SetName of the sticker set to which the sticker belongs // // optional SetName string `json:"set_name,omitempty"` // MaskPosition is for mask stickers, the position where the mask should be // placed // // optional MaskPosition *MaskPosition `json:"mask_position,omitempty"` // FileSize // // optional FileSize int `json:"file_size,omitempty"` } // StickerSet represents a sticker set. type StickerSet struct { // Name sticker set name Name string `json:"name"` // Title sticker set title Title string `json:"title"` // IsAnimated true, if the sticker set contains animated stickers IsAnimated bool `json:"is_animated"` // ContainsMasks true, if the sticker set contains masks ContainsMasks bool `json:"contains_masks"` // Stickers list of all set stickers Stickers []Sticker `json:"stickers"` // Thumb is the sticker set thumbnail in the .WEBP or .TGS format Thumbnail *PhotoSize `json:"thumb"` } // MaskPosition 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 string `json:"point"` // Shift by X-axis measured in widths of the mask scaled to the face size, // from left to right. For example, choosing -1.0 will place mask just to // the left of the default mask position. XShift float64 `json:"x_shift"` // Shift by Y-axis measured in heights of the mask scaled to the face size, // from top to bottom. For example, 1.0 will place the mask just below the // default mask position. YShift float64 `json:"y_shift"` // Mask scaling coefficient. For example, 2.0 means double size. Scale float64 `json:"scale"` } // Game 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"` // Text a 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. // // optional Text string `json:"text,omitempty"` // TextEntities special entities that appear in text, such as usernames, URLs, bot commands, etc. // // optional TextEntities []MessageEntity `json:"text_entities,omitempty"` // Animation animation that will be displayed in the game message in chats. // Upload via BotFather (https://t.me/botfather). // // optional Animation Animation `json:"animation,omitempty"` } // GameHighScore is a user's score and position on the leaderboard. type GameHighScore struct { // Position in high score table for the game Position int `json:"position"` // User user User User `json:"user"` // Score score Score int `json:"score"` } // CallbackGame is for starting a game in an inline keyboard button. type CallbackGame struct{} // WebhookInfo is information about a currently set webhook. type WebhookInfo struct { // URL webhook URL, may be empty if webhook is not set up. URL string `json:"url"` // HasCustomCertificate true, if a custom certificate was provided for webhook certificate checks. HasCustomCertificate bool `json:"has_custom_certificate"` // PendingUpdateCount number of updates awaiting delivery. PendingUpdateCount int `json:"pending_update_count"` // IPAddress is the currently used webhook IP address // // optional IPAddress string `json:"ip_address,omitempty"` // LastErrorDate unix time for the most recent error // that happened when trying to deliver an update via webhook. // // optional LastErrorDate int `json:"last_error_date,omitempty"` // LastErrorMessage error message in human-readable format for the most recent error // that happened when trying to deliver an update via webhook. // // optional LastErrorMessage string `json:"last_error_message,omitempty"` // MaxConnections maximum allowed number of simultaneous // HTTPS connections to the webhook for update delivery. // // optional MaxConnections int `json:"max_connections,omitempty"` // AllowedUpdates is a list of update types the bot is subscribed to. // Defaults to all update types // // optional AllowedUpdates []string `json:"allowed_updates,omitempty"` } // IsSet returns true if a webhook is currently set. func (info WebhookInfo) IsSet() bool { return info.URL != "" } // InlineQuery is a Query from Telegram for an inline request. type InlineQuery struct { // ID unique identifier for this query ID string `json:"id"` // From sender From *User `json:"from"` // Query 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"` // 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 // // optional ChatType string `json:"chat_type"` // Location sender location, only for bots that request user location. // // optional Location *Location `json:"location,omitempty"` } // InlineQueryResultCachedAudio is an inline query response with cached audio. type InlineQueryResultCachedAudio struct { // Type of the result, must be audio Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // AudioID a valid file identifier for the audio file AudioID string `json:"audio_file_id"` // Caption 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the audio // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultCachedDocument is an inline query response with cached document. type InlineQueryResultCachedDocument struct { // Type of the result, must be document Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // DocumentID a valid file identifier for the file DocumentID string `json:"document_file_id"` // Title for the result // // optional Title string `json:"title,omitempty"` // Caption of the document to be sent, 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // Description short description of the result // // optional Description string `json:"description,omitempty"` // ParseMode mode for parsing entities in the video caption. // // See formatting options for more details // // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the file // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultCachedGIF is an inline query response with cached gif. type InlineQueryResultCachedGIF struct { // Type of the result, must be gif. Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes. ID string `json:"id"` // GifID a valid file identifier for the GIF file. GIFID string `json:"gif_file_id"` // Title for the result // // optional Title string `json:"title,omitempty"` // Caption of the GIF file to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the GIF animation. // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultCachedMPEG4GIF is an inline query response with cached // H.264/MPEG-4 AVC video without sound gif. type InlineQueryResultCachedMPEG4GIF struct { // Type of the result, must be mpeg4_gif Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // MPEG4FileID a valid file identifier for the MP4 file MPEG4FileID string `json:"mpeg4_file_id"` // Title for the result // // optional Title string `json:"title,omitempty"` // Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the video animation. // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultCachedPhoto is an inline query response with cached photo. type InlineQueryResultCachedPhoto struct { // Type of the result, must be photo. Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes. ID string `json:"id"` // PhotoID a valid file identifier of the photo. PhotoID string `json:"photo_file_id"` // Title for the result. // // optional Title string `json:"title,omitempty"` // Description short description of the result. // // optional Description string `json:"description,omitempty"` // Caption of the photo to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the photo caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the photo. // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultCachedSticker is an inline query response with cached sticker. type InlineQueryResultCachedSticker struct { // Type of the result, must be sticker Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // StickerID a valid file identifier of the sticker StickerID string `json:"sticker_file_id"` // Title is a title Title string `json:"title"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the sticker // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultCachedVideo is an inline query response with cached video. type InlineQueryResultCachedVideo struct { // Type of the result, must be video Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // VideoID a valid file identifier for the video file VideoID string `json:"video_file_id"` // Title for the result Title string `json:"title"` // Description short description of the result // // optional Description string `json:"description,omitempty"` // Caption of the video to be sent, 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the video // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultCachedVoice is an inline query response with cached voice. type InlineQueryResultCachedVoice struct { // Type of the result, must be voice Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // VoiceID a valid file identifier for the voice message VoiceID string `json:"voice_file_id"` // Title voice message title Title string `json:"title"` // Caption 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the voice message // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultArticle represents a link to an article or web page. type InlineQueryResultArticle struct { // Type of the result, must be article. Type string `json:"type"` // ID unique identifier for this result, 1-64 Bytes. ID string `json:"id"` // Title of the result Title string `json:"title"` // InputMessageContent content of the message to be sent. InputMessageContent interface{} `json:"input_message_content,omitempty"` // ReplyMarkup Inline keyboard attached to the message. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // URL of the result. // // optional URL string `json:"url,omitempty"` // HideURL pass True, if you don't want the URL to be shown in the message. // // optional HideURL bool `json:"hide_url,omitempty"` // Description short description of the result. // // optional Description string `json:"description,omitempty"` // ThumbURL url of the thumbnail for the result // // optional ThumbURL string `json:"thumb_url,omitempty"` // ThumbWidth thumbnail width // // optional ThumbWidth int `json:"thumb_width,omitempty"` // ThumbHeight thumbnail height // // optional ThumbHeight int `json:"thumb_height,omitempty"` } // InlineQueryResultAudio is an inline query response audio. type InlineQueryResultAudio struct { // Type of the result, must be audio Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // URL a valid url for the audio file URL string `json:"audio_url"` // Title is a title Title string `json:"title"` // Caption 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Performer is a performer // // optional Performer string `json:"performer,omitempty"` // Duration audio duration in seconds // // optional Duration int `json:"audio_duration,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the audio // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultContact is an inline query response contact. type InlineQueryResultContact struct { Type string `json:"type"` // required ID string `json:"id"` // required PhoneNumber string `json:"phone_number"` // required FirstName string `json:"first_name"` // required LastName string `json:"last_name"` VCard string `json:"vcard"` ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` InputMessageContent interface{} `json:"input_message_content,omitempty"` ThumbURL string `json:"thumb_url"` ThumbWidth int `json:"thumb_width"` ThumbHeight int `json:"thumb_height"` } // InlineQueryResultGame is an inline query response game. type InlineQueryResultGame struct { // Type of the result, must be game Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // GameShortName short name of the game GameShortName string `json:"game_short_name"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` } // InlineQueryResultDocument is an inline query response document. type InlineQueryResultDocument struct { // Type of the result, must be document Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // Title for the result Title string `json:"title"` // Caption of the document to be sent, 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // URL a valid url for the file URL string `json:"document_url"` // MimeType of the content of the file, either “application/pdf” or “application/zip” MimeType string `json:"mime_type"` // Description short description of the result // // optional Description string `json:"description,omitempty"` // ReplyMarkup nline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the file // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` // ThumbURL url of the thumbnail (jpeg only) for the file // // optional ThumbURL string `json:"thumb_url,omitempty"` // ThumbWidth thumbnail width // // optional ThumbWidth int `json:"thumb_width,omitempty"` // ThumbHeight thumbnail height // // optional ThumbHeight int `json:"thumb_height,omitempty"` } // InlineQueryResultGIF is an inline query response GIF. type InlineQueryResultGIF struct { // Type of the result, must be gif. Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes. ID string `json:"id"` // URL a valid URL for the GIF file. File size must not exceed 1MB. URL string `json:"gif_url"` // ThumbURL url of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. ThumbURL string `json:"thumb_url"` // Width of the GIF // // optional Width int `json:"gif_width,omitempty"` // Height of the GIF // // optional Height int `json:"gif_height,omitempty"` // Duration of the GIF // // optional Duration int `json:"gif_duration,omitempty"` // Title for the result // // optional Title string `json:"title,omitempty"` // Caption of the GIF file to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the GIF animation. // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultLocation is an inline query response location. type InlineQueryResultLocation struct { // Type of the result, must be location Type string `json:"type"` // ID unique identifier for this result, 1-64 Bytes ID string `json:"id"` // Latitude of the location in degrees Latitude float64 `json:"latitude"` // Longitude of the location in degrees Longitude float64 `json:"longitude"` // Title of the location Title string `json:"title"` // HorizontalAccuracy is the radius of uncertainty for the location, // measured in meters; 0-1500 // // optional HorizontalAccuracy float64 `json:"horizontal_accuracy"` // LivePeriod is the period in seconds for which the location can be // updated, should be between 60 and 86400. // // optional LivePeriod int `json:"live_period"` // Heading is for live locations, a direction in which the user is moving, // in degrees. Must be between 1 and 360 if specified. // // optional Heading int `json:"heading"` // ProximityAlertRadius is for live locations, a maximum distance for // proximity alerts about approaching another chat member, in meters. Must // be between 1 and 100000 if specified. // // optional ProximityAlertRadius int `json:"proximity_alert_radius"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the location // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` // ThumbURL url of the thumbnail for the result // // optional ThumbURL string `json:"thumb_url,omitempty"` // ThumbWidth thumbnail width // // optional ThumbWidth int `json:"thumb_width,omitempty"` // ThumbHeight thumbnail height // // optional ThumbHeight int `json:"thumb_height,omitempty"` } // InlineQueryResultMPEG4GIF is an inline query response MPEG4 GIF. type InlineQueryResultMPEG4GIF struct { // Type of the result, must be mpeg4_gif Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // URL a valid URL for the MP4 file. File size must not exceed 1MB URL string `json:"mpeg4_url"` // Width video width // // optional Width int `json:"mpeg4_width"` // Height vVideo height // // optional Height int `json:"mpeg4_height"` // Duration video duration // // optional Duration int `json:"mpeg4_duration"` // ThumbURL url of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. ThumbURL string `json:"thumb_url"` // Title for the result // // optional Title string `json:"title,omitempty"` // Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the video animation // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultPhoto is an inline query response photo. type InlineQueryResultPhoto struct { // Type of the result, must be article. Type string `json:"type"` // ID unique identifier for this result, 1-64 Bytes. ID string `json:"id"` // URL a valid URL of the photo. Photo must be in jpeg format. // Photo size must not exceed 5MB. URL string `json:"photo_url"` // MimeType MimeType string `json:"mime_type"` // Width of the photo // // optional Width int `json:"photo_width,omitempty"` // Height of the photo // // optional Height int `json:"photo_height,omitempty"` // ThumbURL url of the thumbnail for the photo. // // optional ThumbURL string `json:"thumb_url,omitempty"` // Title for the result // // optional Title string `json:"title,omitempty"` // Description short description of the result // // optional Description string `json:"description,omitempty"` // Caption of the photo to be sent, 0-1024 characters after entities parsing. // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the photo caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // ReplyMarkup inline keyboard attached to the message. // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // InputMessageContent content of the message to be sent instead of the photo. // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultVenue is an inline query response venue. type InlineQueryResultVenue struct { // Type of the result, must be venue Type string `json:"type"` // ID 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"` // FoursquareID foursquare identifier of the venue if known // // optional FoursquareID string `json:"foursquare_id,omitempty"` // FoursquareType foursquare type of the venue, if known. // (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) // // optional FoursquareType string `json:"foursquare_type,omitempty"` // GooglePlaceID is the Google Places identifier of the venue // // optional GooglePlaceID string `json:"google_place_id,omitempty"` // GooglePlaceType is the Google Places type of the venue // // optional GooglePlaceType string `json:"google_place_type,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the venue // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` // ThumbURL url of the thumbnail for the result // // optional ThumbURL string `json:"thumb_url,omitempty"` // ThumbWidth thumbnail width // // optional ThumbWidth int `json:"thumb_width,omitempty"` // ThumbHeight thumbnail height // // optional ThumbHeight int `json:"thumb_height,omitempty"` } // InlineQueryResultVideo is an inline query response video. type InlineQueryResultVideo struct { // Type of the result, must be video Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // URL a valid url for the embedded video player or video file URL string `json:"video_url"` // MimeType of the content of video url, “text/html” or “video/mp4” MimeType string `json:"mime_type"` // // ThumbURL url of the thumbnail (jpeg only) for the video // optional ThumbURL string `json:"thumb_url,omitempty"` // Title for the result Title string `json:"title"` // Caption of the video to be sent, 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // Width video width // // optional Width int `json:"video_width,omitempty"` // Height video height // // optional Height int `json:"video_height,omitempty"` // Duration video duration in seconds // // optional Duration int `json:"video_duration,omitempty"` // Description short description of the result // // optional Description string `json:"description,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent 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). // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // InlineQueryResultVoice is an inline query response voice. type InlineQueryResultVoice struct { // Type of the result, must be voice Type string `json:"type"` // ID unique identifier for this result, 1-64 bytes ID string `json:"id"` // URL a valid URL for the voice recording URL string `json:"voice_url"` // Title recording title Title string `json:"title"` // Caption 0-1024 characters after entities parsing // // optional Caption string `json:"caption,omitempty"` // ParseMode mode for parsing entities in the video caption. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // CaptionEntities is a list of special entities that appear in the caption, // which can be specified instead of parse_mode // // optional CaptionEntities []MessageEntity `json:"caption_entities,omitempty"` // Duration recording duration in seconds // // optional Duration int `json:"voice_duration,omitempty"` // ReplyMarkup inline keyboard attached to the message // // optional ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` // InputMessageContent content of the message to be sent instead of the voice recording // // optional InputMessageContent interface{} `json:"input_message_content,omitempty"` } // ChosenInlineResult is an inline query result chosen by a User type ChosenInlineResult struct { // ResultID the unique identifier for the result that was chosen ResultID string `json:"result_id"` // From the user that chose the result From *User `json:"from"` // Location sender location, only for bots that require user location // // optional Location *Location `json:"location,omitempty"` // InlineMessageID 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. // // optional InlineMessageID string `json:"inline_message_id,omitempty"` // Query the query that was used to obtain the result Query string `json:"query"` } // InputTextMessageContent contains text for displaying // as an inline query result. type InputTextMessageContent struct { // Text of the message to be sent, 1-4096 characters Text string `json:"message_text"` // ParseMode mode for parsing entities in the message text. // See formatting options for more details // (https://core.telegram.org/bots/api#formatting-options). // // optional ParseMode string `json:"parse_mode,omitempty"` // Entities is a list of special entities that appear in message text, which // can be specified instead of parse_mode // // optional Entities []MessageEntity `json:"entities,omitempty"` // DisableWebPagePreview disables link previews for links in the sent message // // optional DisableWebPagePreview bool `json:"disable_web_page_preview,omitempty"` } // InputLocationMessageContent contains a location for displaying // as an inline query result. type InputLocationMessageContent struct { // Latitude of the location in degrees Latitude float64 `json:"latitude"` // Longitude of the location in degrees Longitude float64 `json:"longitude"` // HorizontalAccuracy is the radius of uncertainty for the location, // measured in meters; 0-1500 // // optional HorizontalAccuracy float64 `json:"horizontal_accuracy"` // LivePeriod is the period in seconds for which the location can be // updated, should be between 60 and 86400 // // optional LivePeriod int `json:"live_period,omitempty"` // Heading is for live locations, a direction in which the user is moving, // in degrees. Must be between 1 and 360 if specified. // // optional Heading int `json:"heading"` // ProximityAlertRadius is for live locations, a maximum distance for // proximity alerts about approaching another chat member, in meters. Must // be between 1 and 100000 if specified. // // optional ProximityAlertRadius int `json:"proximity_alert_radius"` } // InputVenueMessageContent contains a venue for displaying // as an inline query result. type InputVenueMessageContent struct { // Latitude of the venue in degrees Latitude float64 `json:"latitude"` // Longitude of the venue in degrees Longitude float64 `json:"longitude"` // Title name of the venue Title string `json:"title"` // Address of the venue Address string `json:"address"` // FoursquareID foursquare identifier of the venue, if known // // optional FoursquareID string `json:"foursquare_id,omitempty"` // FoursquareType Foursquare type of the venue, if known // // optional FoursquareType string `json:"foursquare_type,omitempty"` // GooglePlaceID is the Google Places identifier of the venue // // optional GooglePlaceID string `json:"google_place_id"` // GooglePlaceType is the Google Places type of the venue // // optional GooglePlaceType string `json:"google_place_type"` } // InputContactMessageContent contains a contact for displaying // as an inline query result. type InputContactMessageContent struct { // PhoneNumber contact's phone number PhoneNumber string `json:"phone_number"` // FirstName contact's first name FirstName string `json:"first_name"` // LastName contact's last name // // optional LastName string `json:"last_name,omitempty"` // Additional data about the contact in the form of a vCard // // optional VCard string `json:"vcard,omitempty"` } // InputInvoiceMessageContent 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 for your internal processes. Payload string `json:"payload"` // Payment provider token, obtained via Botfather ProviderToken string `json:"provider_token"` // Three-letter ISO 4217 currency code Currency string `json:"currency"` // Price breakdown, a JSON-serialized list of components (e.g. product // price, tax, discount, delivery cost, delivery tax, bonus, etc.) Prices []LabeledPrice `json:"prices"` // The maximum accepted amount for tips in the smallest units of the // currency (integer, not float/double). // // optional MaxTipAmount int `json:"max_tip_amount,omitempty"` // An 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. // // optional SuggestedTipAmounts []int `json:"suggested_tip_amounts,omitempty"` // 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. // // optional ProviderData string `json:"provider_data,omitempty"` // URL of the product photo for the invoice. Can be a photo of the goods or // a marketing image for a service. People like it better when they see what // they are paying for. // // optional PhotoURL string `json:"photo_url,omitempty"` // Photo size // // optional PhotoSize int `json:"photo_size,omitempty"` // Photo width // // optional PhotoWidth int `json:"photo_width,omitempty"` // Photo height // // optional PhotoHeight int `json:"photo_height,omitempty"` // Pass True, if you require the user's full name to complete the order // // optional NeedName bool `json:"need_name,omitempty"` // Pass True, if you require the user's phone number to complete the order // // optional NeedPhoneNumber bool `json:"need_phone_number,omitempty"` // Pass True, if you require the user's email address to complete the order // // optional NeedEmail bool `json:"need_email,omitempty"` // Pass True, if you require the user's shipping address to complete the order // // optional NeedShippingAddress bool `json:"need_shipping_address,omitempty"` // Pass True, if user's phone number should be sent to provider // // optional SendPhoneNumberToProvider bool `json:"send_phone_number_to_provider,omitempty"` // Pass True, if user's email address should be sent to provider // // optional SendEmailToProvider bool `json:"send_email_to_provider,omitempty"` // Pass True, if the final price depends on the shipping method // // optional IsFlexible bool `json:"is_flexible,omitempty"` } // LabeledPrice represents a portion of the price for goods or services. type LabeledPrice struct { // Label portion label Label string `json:"label"` // Amount 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 // (https://core.telegram.org/bots/payments/currencies.json), // it shows the number of digits past the decimal point // for each currency (2 for the majority of currencies). Amount int `json:"amount"` } // Invoice contains basic information about an invoice. type Invoice struct { // Title product name Title string `json:"title"` // Description product description Description string `json:"description"` // StartParameter unique bot deep-linking parameter that can be used to generate this invoice StartParameter string `json:"start_parameter"` // Currency three-letter ISO 4217 currency code // (see https://core.telegram.org/bots/payments#supported-currencies) Currency string `json:"currency"` // TotalAmount total price in the smallest units of the currency (integer, not float/double). // For example, for a price of US$ 1.45 pass amount = 145. // See the exp parameter in currencies.json // (https://core.telegram.org/bots/payments/currencies.json), // it shows the number of digits past the decimal point // for each currency (2 for the majority of currencies). TotalAmount int `json:"total_amount"` } // ShippingAddress represents a shipping address. type ShippingAddress struct { // CountryCode ISO 3166-1 alpha-2 country code CountryCode string `json:"country_code"` // State if applicable State string `json:"state"` // City city City string `json:"city"` // StreetLine1 first line for the address StreetLine1 string `json:"street_line1"` // StreetLine2 second line for the address StreetLine2 string `json:"street_line2"` // PostCode address post code PostCode string `json:"post_code"` } // OrderInfo represents information about an order. type OrderInfo struct { // Name user name // // optional Name string `json:"name,omitempty"` // PhoneNumber user's phone number // // optional PhoneNumber string `json:"phone_number,omitempty"` // Email user email // // optional Email string `json:"email,omitempty"` // ShippingAddress user shipping address // // optional ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"` } // ShippingOption represents one shipping option. type ShippingOption struct { // ID shipping option identifier ID string `json:"id"` // Title option title Title string `json:"title"` // Prices list of price portions Prices []LabeledPrice `json:"prices"` } // SuccessfulPayment contains basic information about a successful payment. type SuccessfulPayment struct { // Currency three-letter ISO 4217 currency code // (see https://core.telegram.org/bots/payments#supported-currencies) Currency string `json:"currency"` // TotalAmount total price in the smallest units of the currency (integer, not float/double). // For example, for a price of US$ 1.45 pass amount = 145. // See the exp parameter in currencies.json, // (https://core.telegram.org/bots/payments/currencies.json) // it shows the number of digits past the decimal point // for each currency (2 for the majority of currencies). TotalAmount int `json:"total_amount"` // InvoicePayload bot specified invoice payload InvoicePayload string `json:"invoice_payload"` // ShippingOptionID identifier of the shipping option chosen by the user // // optional ShippingOptionID string `json:"shipping_option_id,omitempty"` // OrderInfo order info provided by the user // // optional OrderInfo *OrderInfo `json:"order_info,omitempty"` // TelegramPaymentChargeID telegram payment identifier TelegramPaymentChargeID string `json:"telegram_payment_charge_id"` // ProviderPaymentChargeID provider payment identifier ProviderPaymentChargeID string `json:"provider_payment_charge_id"` } // ShippingQuery contains information about an incoming shipping query. type ShippingQuery struct { // ID unique query identifier ID string `json:"id"` // From user who sent the query From *User `json:"from"` // InvoicePayload bot specified invoice payload InvoicePayload string `json:"invoice_payload"` // ShippingAddress user specified shipping address ShippingAddress *ShippingAddress `json:"shipping_address"` } // PreCheckoutQuery contains information about an incoming pre-checkout query. type PreCheckoutQuery struct { // ID unique query identifier ID string `json:"id"` // From user who sent the query From *User `json:"from"` // Currency three-letter ISO 4217 currency code // // (see https://core.telegram.org/bots/payments#supported-currencies) Currency string `json:"currency"` // TotalAmount total price in the smallest units of the currency (integer, not float/double). // // For example, for a price of US$ 1.45 pass amount = 145. // // See the exp parameter in currencies.json, // // (https://core.telegram.org/bots/payments/currencies.json) // // it shows the number of digits past the decimal point // // for each currency (2 for the majority of currencies). TotalAmount int `json:"total_amount"` // InvoicePayload bot specified invoice payload InvoicePayload string `json:"invoice_payload"` // ShippingOptionID identifier of the shipping option chosen by the user // // optional ShippingOptionID string `json:"shipping_option_id,omitempty"` // OrderInfo order info provided by the user // // optional OrderInfo *OrderInfo `json:"order_info,omitempty"` }