telegram-bot-api/types.go

3795 lines
134 KiB
Go
Raw Normal View History

package tgbotapi
import (
"encoding/json"
2016-04-14 00:06:18 +02:00
"errors"
"fmt"
2016-04-12 15:28:46 +02:00
"net/url"
2015-11-21 15:26:28 +01:00
"strings"
2015-11-21 15:39:19 +01:00
"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"`
}
2020-11-06 05:29:48 +01:00
// 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 {
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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"`
2021-03-09 18:27:17 +01:00
// 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
2022-08-07 00:55:52 +02:00
MyChatMember *ChatMemberUpdated `json:"my_chat_member,omitempty"`
2021-03-09 18:27:17 +01:00
// 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
2022-08-07 00:55:52 +02:00
ChatMember *ChatMemberUpdated `json:"chat_member,omitempty"`
2021-11-08 20:17:17 +01:00
// 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
2022-08-07 00:55:52 +02:00
ChatJoinRequest *ChatJoinRequest `json:"chat_join_request,omitempty"`
}
2021-11-08 21:37:50 +01:00
// SentFrom returns the user who sent an update. Can be nil, if Telegram did not provide information
// about the user in the update object.
2021-02-02 12:56:51 +01:00
func (u *Update) SentFrom() *User {
switch {
case u.Message != nil:
return u.Message.From
case u.EditedMessage != nil:
return u.EditedMessage.From
case u.InlineQuery != nil:
return u.InlineQuery.From
case u.ChosenInlineResult != nil:
return u.ChosenInlineResult.From
case u.CallbackQuery != nil:
return u.CallbackQuery.From
case u.ShippingQuery != nil:
return u.ShippingQuery.From
case u.PreCheckoutQuery != nil:
return u.PreCheckoutQuery.From
default:
return nil
}
}
2021-11-08 21:37:50 +01:00
// CallbackData returns the callback query data, if it exists.
2021-02-02 13:38:41 +01:00
func (u *Update) CallbackData() string {
if u.CallbackQuery != nil {
return u.CallbackQuery.Data
}
return ""
}
// FromChat returns the chat where an update occurred.
2021-02-02 13:38:41 +01:00
func (u *Update) FromChat() *Chat {
switch {
case u.Message != nil:
return u.Message.Chat
case u.EditedMessage != nil:
return u.EditedMessage.Chat
case u.ChannelPost != nil:
return u.ChannelPost.Chat
case u.EditedChannelPost != nil:
return u.EditedChannelPost.Chat
case u.CallbackQuery != nil:
return u.CallbackQuery.Message.Chat
default:
return nil
}
}
// 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
}
}
2020-11-06 05:29:48 +01:00
// User represents a Telegram user or bot.
type User struct {
2020-11-06 05:29:48 +01:00
// ID is a unique identifier for this user or bot
2021-03-09 18:38:15 +01:00
ID int64 `json:"id"`
2020-11-06 05:29:48 +01:00
// IsBot true, if this user is a bot
//
// optional
IsBot bool `json:"is_bot,omitempty"`
2022-06-20 04:08:13 +02:00
// IsPremium true, if user has Telegram Premium
//
// optional
IsPremium bool `json:"is_premium,omitempty"`
2022-11-20 20:58:26 +01:00
// AddedToAttachmentMenu true, if this user added the bot to the attachment menu
//
// optional
AddedToAttachmentMenu bool `json:"added_to_attachment_menu,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
}
2015-07-31 09:22:01 +02:00
// 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.
2015-07-31 09:22:01 +02:00
func (u *User) String() string {
if u == nil {
return ""
}
2015-07-31 09:22:01 +02:00
if u.UserName != "" {
return u.UserName
}
name := u.FirstName
if u.LastName != "" {
name += " " + u.LastName
}
return name
}
2020-11-06 05:29:48 +01:00
// Chat represents a chat.
type Chat struct {
2020-11-06 05:29:48 +01:00
// 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"`
2022-11-06 00:32:26 +01:00
// IsForum is true if the supergroup chat is a forum (has topics enabled)
//
// optional
IsForum bool `json:"is_forum,omitempty"`
2020-11-06 05:29:48 +01:00
// Photo is a chat photo
Photo *ChatPhoto `json:"photo"`
2022-11-06 00:32:26 +01:00
// If non-empty, the list of all active chat usernames;
// for private chats, supergroups and channels. Returned only in getChat.
//
// optional
ActiveUsernames []string `json:"active_usernames,omitempty"`
2022-12-31 01:15:29 +01:00
// Custom emoji identifier of emoji status of the other party
2022-11-06 00:32:26 +01:00
// in a private chat. Returned only in getChat.
//
// optional
EmojiStatusCustomEmojiID string `json:"emoji_status_custom_emoji_id,omitempty"`
// Bio is the bio of the other party in a private chat. Returned only in
// getChat
//
// optional
Bio string `json:"bio,omitempty"`
2021-12-07 16:08:41 +01:00
// HasPrivateForwards is true if privacy settings of the other party in the
// private chat allows to use tg://user?id=<user_id> links only in chats
// with the user. Returned only in getChat.
//
// optional
HasPrivateForwards bool `json:"has_private_forwards,omitempty"`
2022-12-31 01:15:29 +01:00
// HasRestrictedVoiceAndVideoMessages if the privacy settings of the other party
// restrict sending voice and video note messages
2022-11-20 20:55:30 +01:00
// in the private chat. Returned only in getChat.
//
// optional
HasRestrictedVoiceAndVideoMessages bool `json:"has_restricted_voice_and_video_messages,omitempty"`
2022-11-20 20:58:26 +01:00
// JoinToSendMessages is true, if users need to join the supergroup
// before they can send messages.
// Returned only in getChat
//
// optional
JoinToSendMessages bool `json:"join_to_send_messages,omitempty"`
// JoinByRequest is true, if all users directly joining the supergroup
// need to be approved by supergroup administrators.
// Returned only in getChat.
//
// optional
JoinByRequest bool `json:"join_by_request,omitempty"`
2020-11-06 05:29:48 +01:00
// 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 are default chat member permissions, for groups and
2020-11-06 05:29:48 +01:00
// supergroups. Returned only in getChat.
//
// optional
Permissions *ChatPermissions `json:"permissions,omitempty"`
// SlowModeDelay is for supergroups, the minimum allowed delay between
2022-10-19 10:58:52 +02:00
// consecutive messages sent by each unprivileged user. Returned only in
2020-11-06 05:29:48 +01:00
// getChat.
//
// optional
SlowModeDelay int `json:"slow_mode_delay,omitempty"`
2021-12-07 16:08:41 +01:00
// MessageAutoDeleteTime is the time after which all messages sent to the
// chat will be automatically deleted; in seconds. Returned only in getChat.
//
// optional
MessageAutoDeleteTime int `json:"message_auto_delete_time,omitempty"`
2023-02-04 03:53:55 +01:00
// HasAggressiveAntiSpamEnabled is true if aggressive anti-spam checks are enabled
// in the supergroup. The field is only available to chat administrators.
2022-12-31 01:15:29 +01:00
// Returned only in getChat.
//
// optional
HasAggressiveAntiSpamEnabled bool `json:"has_aggressive_anti_spam_enabled,omitempty"`
// HasHiddenMembers is true if non-administrators can only get
// the list of bots and administrators in the chat.
//
// optional
HasHiddenMembers bool `json:"has_hidden_members,omitempty"`
2021-12-07 16:08:41 +01:00
// HasProtectedContent is true if messages from the chat can't be forwarded
// to other chats. Returned only in getChat.
//
// optional
HasProtectedContent bool `json:"has_protected_content,omitempty"`
2020-11-06 05:29:48 +01:00
// 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
2022-08-07 00:55:52 +02:00
Location *ChatLocation `json:"location,omitempty"`
}
// IsPrivate returns if the Chat is a private conversation.
2016-05-22 17:16:28 +02:00
func (c Chat) IsPrivate() bool {
return c.Type == "private"
}
// IsGroup returns if the Chat is a group.
2016-05-22 17:16:28 +02:00
func (c Chat) IsGroup() bool {
return c.Type == "group"
}
// IsSuperGroup returns if the Chat is a supergroup.
2016-05-22 17:16:28 +02:00
func (c Chat) IsSuperGroup() bool {
return c.Type == "supergroup"
}
// IsChannel returns if the Chat is a channel.
2016-05-22 17:16:28 +02:00
func (c Chat) IsChannel() bool {
return c.Type == "channel"
}
2016-05-22 17:16:28 +02:00
// ChatConfig returns a ChatConfig struct for chat related methods.
func (c Chat) ChatConfig() ChatConfig {
return ChatConfig{ChatID: c.ID}
}
2020-11-06 05:29:48 +01:00
// Message represents a message.
type Message struct {
2020-11-06 05:29:48 +01:00
// MessageID is a unique message identifier inside this chat
MessageID int `json:"message_id"`
2022-11-06 00:32:26 +01:00
// Unique identifier of a message thread to which the message belongs;
// for supergroups only
//
// optional
MessageThreadID int `json:"message_thread_id,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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"`
2022-11-06 00:32:26 +01:00
// IsTopicMessage true if the message is sent to a forum topic
//
// optional
IsTopicMessage bool `json:"is_topic_message,omitempty"`
2021-12-07 16:08:41 +01:00
// IsAutomaticForward is true if the message is a channel post that was
// automatically forwarded to the connected discussion group.
//
// optional
IsAutomaticForward bool `json:"is_automatic_forward,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2021-12-07 16:08:41 +01:00
// HasProtectedContent is true if the message can't be forwarded.
//
// optional
HasProtectedContent bool `json:"has_protected_content,omitempty"`
2020-11-06 05:29:48 +01:00
// 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 are for text messages, special entities like usernames,
2020-11-06 05:29:48 +01:00
// 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"`
// PremiumAnimation message is an animation, information about the animation.
// For backward compatibility, when this field is set, the document field will also be set;
//
// optional
PremiumAnimation *Animation `json:"premium_animation,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2022-12-31 01:15:29 +01:00
// HasSpoiler True, if the message media is covered by a spoiler animation
//
// optional
HasMediaSpoiler bool `json:"has_media_spoiler,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2021-03-09 18:27:17 +01:00
// MessageAutoDeleteTimerChanged is a service message: auto-delete timer
// settings changed in the chat.
//
// optional
2022-08-07 00:55:52 +02:00
MessageAutoDeleteTimerChanged *MessageAutoDeleteTimerChanged `json:"message_auto_delete_timer_changed,omitempty"`
2020-11-06 05:29:48 +01:00
// 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
2020-11-06 05:29:48 +01:00
// 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
2020-11-06 05:29:48 +01:00
// 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"`
2023-02-04 03:53:55 +01:00
// UserShared is a service message: a user was shared with the bot
//
// optional
UserShared *UserShared `json:"user_shared,omitempty"`
// ChatShared is a service message: a chat was shared with the bot
//
// optional
ChatShared *ChatShared `json:"chat_shared,omitempty"`
// ConnectedWebsite is the domain name of the website on which the user has
2020-11-06 05:29:48 +01:00
// logged in;
//
// optional
ConnectedWebsite string `json:"connected_website,omitempty"`
2022-12-31 01:15:29 +01:00
// WriteAccessAllowed is a service message: the user allowed the bot
// added to the attachment menu to write messages
//
// optional
WriteAccessAllowed *WriteAccessAllowed `json:"write_access_allowed,omitempty"`
2020-11-06 05:29:48 +01:00
// 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
2022-08-07 00:55:52 +02:00
ProximityAlertTriggered *ProximityAlertTriggered `json:"proximity_alert_triggered,omitempty"`
2022-11-06 00:32:26 +01:00
// ForumTopicCreated is a service message: forum topic created
//
// optional
ForumTopicCreated *ForumTopicCreated `json:"forum_topic_created,omitempty"`
2022-12-31 01:15:29 +01:00
// ForumTopicClosed is a service message: forum topic edited
//
// optional
ForumTopicEdited *ForumTopicEdited `json:"forum_topic_edited,omitempty"`
2022-11-06 00:32:26 +01:00
// ForumTopicClosed is a service message: forum topic closed
//
// optional
ForumTopicClosed *ForumTopicClosed `json:"forum_topic_closed,omitempty"`
// ForumTopicReopened is a service message: forum topic reopened
//
// optional
ForumTopicReopened *ForumTopicReopened `json:"forum_topic_reopened,omitempty"`
2022-12-31 01:15:29 +01:00
// GeneralForumTopicHidden is a service message: the 'General' forum topic hidden
//
// optional
GeneralForumTopicHidden *GeneralForumTopicHidden `json:"general_forum_topic_hidden,omitempty"`
// GeneralForumTopicUnhidden is a service message: the 'General' forum topic unhidden
//
// optional
GeneralForumTopicUnhidden *GeneralForumTopicUnhidden `json:"general_forum_topic_unhidden,omitempty"`
2022-04-16 18:36:59 +02:00
// VideoChatScheduled is a service message: video chat scheduled.
//
// optional
2022-08-07 00:55:52 +02:00
VideoChatScheduled *VideoChatScheduled `json:"video_chat_scheduled,omitempty"`
2022-04-16 18:36:59 +02:00
// VideoChatStarted is a service message: video chat started.
2021-03-09 18:27:17 +01:00
//
// optional
2022-08-07 00:55:52 +02:00
VideoChatStarted *VideoChatStarted `json:"video_chat_started,omitempty"`
2022-04-16 18:36:59 +02:00
// VideoChatEnded is a service message: video chat ended.
2021-03-09 18:27:17 +01:00
//
// optional
2022-08-07 00:55:52 +02:00
VideoChatEnded *VideoChatEnded `json:"video_chat_ended,omitempty"`
2022-04-16 18:36:59 +02:00
// VideoChatParticipantsInvited is a service message: new participants
// invited to a video chat.
2021-03-09 18:27:17 +01:00
//
// optional
2022-08-07 00:55:52 +02:00
VideoChatParticipantsInvited *VideoChatParticipantsInvited `json:"video_chat_participants_invited,omitempty"`
2022-04-16 18:36:59 +02:00
// WebAppData is a service message: data sent by a Web App.
//
// optional
2022-08-07 00:55:52 +02:00
WebAppData *WebAppData `json:"web_app_data,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
}
2015-07-31 19:40:42 +02:00
// 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.
2015-11-21 14:43:39 +01:00
func (m *Message) IsCommand() bool {
2018-10-09 06:32:34 +02:00
if m.Entities == nil || len(m.Entities) == 0 {
return false
}
2018-10-09 06:32:34 +02:00
entity := m.Entities[0]
2019-01-10 12:40:12 +01:00
return entity.Offset == 0 && entity.IsCommand()
2015-11-21 14:43:39 +01:00
}
// 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.
2015-11-21 15:26:28 +01:00
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
2018-10-09 06:32:34 +02:00
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
2018-10-09 06:32:34 +02:00
entity := m.Entities[0]
2017-12-29 06:17:32 +01:00
if len(m.Text) == entity.Length {
return "" // The command makes up the whole message
}
2018-03-26 18:54:02 +02:00
return m.Text[entity.Length+1:]
2015-11-21 15:26:28 +01:00
}
2020-11-06 18:36:00 +01:00
// MessageID represents a unique message identifier.
type MessageID struct {
MessageID int `json:"message_id"`
}
2020-11-06 05:29:48 +01:00
// MessageEntity represents one special entity in a text message.
2016-04-12 15:28:46 +02:00
type MessageEntity struct {
2020-11-06 05:29:48 +01:00
// 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),
// "spoiler" (spoiler message),
2020-11-06 05:29:48 +01:00
// “code” (monowidth string),
// “pre” (monowidth block),
// “text_link” (for clickable text URLs),
// “text_mention” (for users without usernames)
2022-11-20 20:55:30 +01:00
// “text_mention” (for inline custom emoji stickers)
2020-11-06 05:29:48 +01:00
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"`
2022-11-20 20:55:30 +01:00
// CustomEmojiID for “custom_emoji” only, unique identifier of the custom emoji
//
// optional
CustomEmojiID string `json:"custom_emoji_id"`
2016-04-12 15:28:46 +02:00
}
// ParseURL attempts to parse a URL contained within a MessageEntity.
2019-01-10 12:40:12 +01:00
func (e MessageEntity) ParseURL() (*url.URL, error) {
if e.URL == "" {
2016-04-14 00:06:18 +02:00
return nil, errors.New(ErrBadURL)
}
2019-01-10 12:40:12 +01:00
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"
}
// IsTextMention returns true if the type of the message entity is "text_mention"
// (At this time, the user field exists, and occurs when tagging a member without a username)
func (e MessageEntity) IsTextMention() bool {
return e.Type == "text_mention"
}
2019-01-10 12:40:12 +01:00
// 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"
}
2020-07-21 21:20:12 +02:00
// IsURL returns true if the type of the message entity is "url".
func (e MessageEntity) IsURL() bool {
2019-01-10 12:40:12 +01:00
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"
2016-04-12 15:28:46 +02:00
}
2020-11-06 05:29:48 +01:00
// PhotoSize represents one size of a photo or a file / sticker thumbnail.
type PhotoSize struct {
2020-11-06 05:29:48 +01:00
// 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.
2020-01-06 08:44:13 +01:00
FileUniqueID string `json:"file_unique_id"`
2020-11-06 05:29:48 +01:00
// Width photo width
Width int `json:"width"`
// Height photo height
Height int `json:"height"`
// FileSize file size
//
// optional
FileSize int `json:"file_size,omitempty"`
}
2020-11-06 05:29:48 +01:00
// Animation represents an animation file.
type Animation struct {
// FileID is the identifier for this file, which can be used to download or reuse
2020-11-06 05:29:48 +01:00
// 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
2023-07-04 21:21:43 +02:00
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
2020-11-06 05:29:48 +01:00
// 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
2022-11-20 20:58:26 +01:00
FileSize int64 `json:"file_size,omitempty"`
2020-11-06 05:29:48 +01:00
}
// Audio represents an audio file to be treated as music by the Telegram clients.
type Audio struct {
2020-11-06 05:29:48 +01:00
// 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.
2020-01-06 08:44:13 +01:00
FileUniqueID string `json:"file_unique_id"`
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// MimeType of the file as defined by sender
//
// optional
MimeType string `json:"mime_type,omitempty"`
// FileSize file size
//
// optional
2022-11-20 20:58:26 +01:00
FileSize int64 `json:"file_size,omitempty"`
2020-11-06 05:29:48 +01:00
// Thumbnail is the album cover to which the music file belongs
//
// optional
2023-07-04 21:21:43 +02:00
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
2020-11-06 05:29:48 +01:00
}
// Document represents a general file.
type Document struct {
// FileID is an identifier for this file, which can be used to download or
2020-11-06 05:29:48 +01:00
// 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
2023-07-04 21:21:43 +02:00
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
2020-11-06 05:29:48 +01:00
// 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
2022-11-20 20:58:26 +01:00
FileSize int64 `json:"file_size,omitempty"`
2020-11-06 05:29:48 +01:00
}
// Video represents a video file.
type Video struct {
2020-11-06 05:29:48 +01:00
// 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
2023-07-04 21:21:43 +02:00
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
// FileName is the original filename as defined by sender
//
// optional
FileName string `json:"file_name,omitempty"`
2020-11-06 05:29:48 +01:00
// MimeType of a file as defined by sender
//
// optional
MimeType string `json:"mime_type,omitempty"`
// FileSize file size
//
// optional
2022-11-20 20:58:26 +01:00
FileSize int64 `json:"file_size,omitempty"`
2020-11-06 05:29:48 +01:00
}
// VideoNote object represents a video message.
2017-05-22 00:04:12 +02:00
type VideoNote struct {
2020-11-06 05:29:48 +01:00
// 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
2023-07-04 21:21:43 +02:00
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
2020-11-06 05:29:48 +01:00
// FileSize file size
//
// optional
FileSize int `json:"file_size,omitempty"`
2017-05-22 00:04:12 +02:00
}
2020-11-06 05:29:48 +01:00
// Voice represents a voice note.
2015-08-18 03:40:42 +02:00
type Voice struct {
2020-11-06 05:29:48 +01:00
// 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.
2020-01-06 08:44:13 +01:00
FileUniqueID string `json:"file_unique_id"`
2020-11-06 05:29:48 +01:00
// 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
2022-11-20 20:58:26 +01:00
FileSize int64 `json:"file_size,omitempty"`
2015-08-18 03:40:42 +02:00
}
2020-11-06 05:29:48 +01:00
// Contact represents a phone contact.
//
// Note that LastName and UserID may be empty.
type Contact struct {
2020-11-06 05:29:48 +01:00
// PhoneNumber contact's phone number
PhoneNumber string `json:"phone_number"`
2020-11-06 05:29:48 +01:00
// 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
2021-03-09 18:38:15 +01:00
UserID int64 `json:"user_id,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2016-04-12 15:28:46 +02:00
}
// PollOption contains information about one answer option in a poll.
type PollOption struct {
2020-11-06 05:29:48 +01:00
// 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"`
}
2020-01-25 04:42:19 +01:00
// PollAnswer represents an answer of a user in a non-anonymous poll.
type PollAnswer struct {
2020-11-06 05:29:48 +01:00
// 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"`
2020-01-25 04:42:19 +01:00
}
// Poll contains information about a poll.
type Poll struct {
2020-11-06 05:29:48 +01:00
// 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"`
// ExplanationEntities are special entities like usernames, URLs, bot
2020-11-06 05:29:48 +01:00
// 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
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
}
// 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"`
2020-03-30 22:35:53 +02:00
}
2022-04-16 18:36:59 +02:00
// WebAppData Contains data sent from a Web App to the bot.
type WebAppData struct {
// Data is the data. Be aware that a bad client can send arbitrary data in this field.
Data string `json:"data"`
// ButtonText is the text of the web_app keyboard button, from which the Web App
// was opened. Be aware that a bad client can send arbitrary data in this field.
ButtonText string `json:"button_text"`
}
2020-11-05 22:53:37 +01:00
// 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
2020-11-05 22:53:37 +01:00
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"`
2020-11-05 22:53:37 +01:00
}
2021-03-09 18:27:17 +01:00
// 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"`
}
2022-11-06 00:32:26 +01:00
// ForumTopicCreated represents a service message about a new forum topic
// created in the chat.
type ForumTopicCreated struct {
// Name is the name of topic
Name string `json:"name"`
// IconColor is the color of the topic icon in RGB format
IconColor int `json:"icon_color"`
// IconCustomEmojiID is the unique identifier of the custom emoji
// shown as the topic icon
//
// optional
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
}
// ForumTopicClosed represents a service message about a forum topic
// closed in the chat. Currently holds no information.
type ForumTopicClosed struct {
}
2022-12-31 01:15:29 +01:00
// ForumTopicEdited object represents a service message about an edited forum topic.
type ForumTopicEdited struct {
// Name is the new name of the topic, if it was edited
//
// optional
Name string `json:"name,omitempty"`
// IconCustomEmojiID is the new identifier of the custom emoji
// shown as the topic icon, if it was edited;
// an empty string if the icon was removed
//
// optional
IconCustomEmojiID *string `json:"icon_custom_emoji_id,omitempty"`
}
2022-11-06 00:32:26 +01:00
// ForumTopicReopened represents a service message about a forum topic
// reopened in the chat. Currently holds no information.
type ForumTopicReopened struct {
}
2022-12-31 01:15:29 +01:00
// GeneralForumTopicHidden represents a service message about General forum topic
// hidden in the chat. Currently holds no information.
type GeneralForumTopicHidden struct {
}
// GeneralForumTopicUnhidden represents a service message about General forum topic
// unhidden in the chat. Currently holds no information.
type GeneralForumTopicUnhidden struct {
}
2023-02-04 03:53:55 +01:00
// UserShared object contains information about the user whose identifier
// was shared with the bot using a KeyboardButtonRequestUser button.
type UserShared struct {
// RequestID is an indentifier of the request.
RequestID int `json:"request_id"`
// UserID in an identifier of the shared user.
UserID int64 `json:"user_id"`
2023-02-04 03:53:55 +01:00
}
// ChatShared contains information about the chat whose identifier
// was shared with the bot using a KeyboardButtonRequestChat button.
type ChatShared struct {
// RequestID is an indentifier of the request.
RequestID int `json:"request_id"`
// ChatID is an identifier of the shared chat.
ChatID int64 `json:"chat_id"`
2023-02-04 03:53:55 +01:00
}
2022-12-31 01:15:29 +01:00
// WriteAccessAllowed represents a service message about a user
// allowing a bot added to the attachment menu to write messages.
// Currently holds no information.
type WriteAccessAllowed struct {
}
2022-04-16 18:36:59 +02:00
// VideoChatScheduled represents a service message about a voice chat scheduled
// in the chat.
2022-04-16 18:36:59 +02:00
type VideoChatScheduled 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.
2022-04-16 18:36:59 +02:00
func (m *VideoChatScheduled) Time() time.Time {
return time.Unix(int64(m.StartDate), 0)
}
2022-04-16 18:36:59 +02:00
// VideoChatStarted represents a service message about a voice chat started in
2021-03-09 18:27:17 +01:00
// the chat.
2022-04-16 18:36:59 +02:00
type VideoChatStarted struct{}
2021-03-09 18:27:17 +01:00
2022-04-16 18:36:59 +02:00
// VideoChatEnded represents a service message about a voice chat ended in the
2021-03-09 18:27:17 +01:00
// chat.
2022-04-16 18:36:59 +02:00
type VideoChatEnded struct {
2021-03-09 18:27:17 +01:00
// Voice chat duration; in seconds.
Duration int `json:"duration"`
}
2022-04-16 18:36:59 +02:00
// VideoChatParticipantsInvited represents a service message about new members
2021-03-09 18:27:17 +01:00
// invited to a voice chat.
2022-04-16 18:36:59 +02:00
type VideoChatParticipantsInvited struct {
2021-03-09 18:27:17 +01:00
// New members that were invited to the voice chat.
//
// optional
2022-08-07 00:55:52 +02:00
Users []User `json:"users,omitempty"`
2020-03-30 22:35:53 +02:00
}
// UserProfilePhotos contains a set of user profile photos.
type UserProfilePhotos struct {
2020-11-06 05:29:48 +01:00
// 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 {
2020-11-06 05:29:48 +01:00
// 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.
2020-01-06 08:44:13 +01:00
FileUniqueID string `json:"file_unique_id"`
2020-11-06 05:29:48 +01:00
// FileSize file size, if known
//
// optional
2022-11-20 20:58:26 +01:00
FileSize int64 `json:"file_size,omitempty"`
2020-11-06 05:29:48 +01:00
// FilePath file path
//
// optional
FilePath string `json:"file_path,omitempty"`
}
// Link returns a full path to the download URL for a File.
//
2020-11-06 05:29:48 +01:00
// It requires the Bot token to create the link.
func (f *File) Link(token string) string {
2015-09-19 20:42:50 +02:00
return fmt.Sprintf(FileEndpoint, token, f.FilePath)
}
2022-04-16 18:36:59 +02:00
// WebAppInfo contains information about a Web App.
type WebAppInfo struct {
// URL is the HTTPS URL of a Web App to be opened with additional data as
// specified in Initializing Web Apps.
URL string `json:"url"`
}
2020-11-06 05:29:48 +01:00
// ReplyKeyboardMarkup represents a custom keyboard with reply options.
type ReplyKeyboardMarkup struct {
2020-11-06 05:29:48 +01:00
// Keyboard is an array of button rows, each represented by an Array of KeyboardButton objects
Keyboard [][]KeyboardButton `json:"keyboard"`
2022-12-31 01:15:29 +01:00
// IsPersistent requests clients to always show the keyboard
// when the regular keyboard is hidden.
// Defaults to false, in which case the custom keyboard can be hidden
// and opened with a keyboard icon.
//
// optional
IsPersistent bool `json:"is_persistent"`
2020-11-06 05:29:48 +01:00
// 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"`
2021-06-27 21:15:09 +02:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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.
2016-04-12 15:28:46 +02:00
type KeyboardButton struct {
2020-11-06 05:29:48 +01:00
// 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"`
2023-02-04 03:53:55 +01:00
// RequestUser if specified, pressing the button will open
// a list of suitable users. Tapping on any user will send
// their identifier to the bot in a "user_shared" service message.
// Available in private chats only.
//
// optional
RequestUser *KeyboardButtonRequestUser `json:"request_user,omitempty"`
// RequestChat if specified, pressing the button will open
// a list of suitable chats. Tapping on a chat will send
// its identifier to the bot in a "chat_shared" service message.
// Available in private chats only.
//
// optional
RequestChat *KeyboardButtonRequestChat `json:"request_chat,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2022-04-16 18:36:59 +02:00
// RequestPoll if specified, the user will be asked to create a poll and send it
2020-11-06 05:29:48 +01:00
// to the bot when the button is pressed. Available in private chats only
//
// optional
RequestPoll *KeyboardButtonPollType `json:"request_poll,omitempty"`
2022-04-16 18:36:59 +02:00
// WebApp if specified, the described Web App will be launched when the button
// is pressed. The Web App will be able to send a “web_app_data” service
// message. Available in private chats only.
//
// optional
WebApp *WebAppInfo `json:"web_app,omitempty"`
2020-01-25 04:42:19 +01:00
}
2023-02-04 03:53:55 +01:00
// KeyboardButtonRequestUser defines the criteria used to request
// a suitable user. The identifier of the selected user will be shared
// with the bot when the corresponding button is pressed.
type KeyboardButtonRequestUser struct {
// RequestID is a signed 32-bit identifier of the request.
RequestID int `json:"request_id"`
// UserIsBot pass True to request a bot,
// pass False to request a regular user.
// If not specified, no additional restrictions are applied.
//
// optional
UserIsBot bool `json:"user_is_bot,omitempty"`
// UserIsPremium pass True to request a premium user,
// pass False to request a non-premium user.
// If not specified, no additional restrictions are applied.
//
// optional
UserIsPremium bool `json:"user_is_premium,omitempty"`
}
// KeyboardButtonRequestChat defines the criteria used to request
// a suitable chat. The identifier of the selected chat will be shared
// with the bot when the corresponding button is pressed.
type KeyboardButtonRequestChat struct {
// RequestID is a signed 32-bit identifier of the request.
RequestID int `json:"request_id"`
// ChatIsChannel pass True to request a channel chat,
// pass False to request a group or a supergroup chat.
ChatIsChannel bool `json:"chat_is_channel"`
// ChatIsForum pass True to request a forum supergroup,
// pass False to request a non-forum chat.
// If not specified, no additional restrictions are applied.
//
// optional
ChatIsForum bool `json:"chat_is_forum,omitempty"`
// ChatHasUsername pass True to request a supergroup or a channel with a username,
// pass False to request a chat without a username.
// If not specified, no additional restrictions are applied.
//
// optional
ChatHasUsername bool `json:"chat_has_username,omitempty"`
// ChatIsCreated pass True to request a chat owned by the user.
// Otherwise, no additional restrictions are applied.
//
// optional
ChatIsCreated bool `json:"chat_is_created,omitempty"`
// UserAdministratorRights is a JSON-serialized object listing
// the required administrator rights of the user in the chat.
// If not specified, no additional restrictions are applied.
//
// optional
UserAdministratorRights *ChatAdministratorRights `json:"user_administrator_rights,omitempty"`
// BotAdministratorRights is a JSON-serialized object listing
// the required administrator rights of the bot in the chat.
// The rights must be a subset of user_administrator_rights.
// If not specified, no additional restrictions are applied.
//
// optional
BotAdministratorRights *ChatAdministratorRights `json:"bot_administrator_rights,omitempty"`
// BotIsMember pass True to request a chat with the bot as a member.
// Otherwise, no additional restrictions are applied.
//
// optional
BotIsMember bool `json:"bot_is_member,omitempty"`
}
// KeyboardButtonPollType represents type of poll, which is allowed to
2020-01-25 04:42:19 +01:00
// be created and sent when the corresponding button is pressed.
type KeyboardButtonPollType struct {
2020-11-06 05:29:48 +01:00
// 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.
2020-01-25 04:42:19 +01:00
Type string `json:"type"`
}
2020-11-06 05:29:48 +01:00
// 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 {
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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.
2016-04-12 15:28:46 +02:00
type InlineKeyboardMarkup struct {
2020-11-06 05:29:48 +01:00
// InlineKeyboard array of button rows, each represented by an Array of
// InlineKeyboardButton objects
2016-04-12 15:28:46 +02:00
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
}
2020-11-06 05:29:48 +01:00
// InlineKeyboardButton represents one button of an inline keyboard. You must
// use exactly one of the optional fields.
2016-04-12 15:28:46 +02:00
//
// Note that some values are references as even an empty string
// will change behavior.
//
// CallbackGame, if set, MUST be first button in first row.
2016-04-12 15:28:46 +02:00
type InlineKeyboardButton struct {
2020-11-06 05:29:48 +01:00
// 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"`
2022-04-16 18:36:59 +02:00
// WebApp is the Description of the Web App that will be launched when the user presses the button.
// The Web App will be able to send an arbitrary message on behalf of the user using the method
// answerWebAppQuery. Available only in private chats between a user and the bot.
//
// optional
WebApp *WebAppInfo `json:"web_app,omitempty"`
2020-11-06 05:29:48 +01:00
// 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.
2019-06-01 02:18:39 +02:00
type LoginURL struct {
2020-11-06 05:29:48 +01:00
// 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.
2016-04-12 15:28:46 +02:00
type CallbackQuery struct {
2020-11-06 05:29:48 +01:00
// 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 {
2020-11-06 05:29:48 +01:00
// ForceReply shows reply interface to the user,
// as if they manually selected the bot's message and tapped 'Reply'.
ForceReply bool `json:"force_reply"`
2021-06-27 21:15:09 +02:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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"`
}
2020-11-06 05:29:48 +01:00
// 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"`
}
2021-03-09 18:27:17 +01:00
// 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"`
2021-11-08 20:17:17 +01:00
// CreatesJoinRequest is true if users joining the chat via the link need to
// be approved by chat administrators.
//
// optional
2022-08-07 00:55:52 +02:00
CreatesJoinRequest bool `json:"creates_join_request,omitempty"`
2021-03-09 18:27:17 +01:00
// 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"`
2021-11-08 20:17:17 +01:00
// Name is the name of the invite link.
//
// optional
2022-08-07 00:55:52 +02:00
Name string `json:"name,omitempty"`
2021-03-09 18:27:17 +01:00
// ExpireDate is the point in time (Unix timestamp) when the link will
// expire or has been expired.
//
// optional
2022-08-07 00:55:52 +02:00
ExpireDate int `json:"expire_date,omitempty"`
2021-03-09 18:27:17 +01:00
// 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
2022-08-07 00:55:52 +02:00
MemberLimit int `json:"member_limit,omitempty"`
2021-11-08 20:17:17 +01:00
// PendingJoinRequestCount is the number of pending join requests created
// using this link.
//
// optional
2022-08-07 00:55:52 +02:00
PendingJoinRequestCount int `json:"pending_join_request_count,omitempty"`
2021-03-09 18:27:17 +01:00
}
2022-04-16 18:36:59 +02:00
type ChatAdministratorRights struct {
IsAnonymous bool `json:"is_anonymous"`
CanManageChat bool `json:"can_manage_chat"`
CanDeleteMessages bool `json:"can_delete_messages"`
CanManageVideoChats bool `json:"can_manage_video_chats"`
CanRestrictMembers bool `json:"can_restrict_members"`
CanPromoteMembers bool `json:"can_promote_members"`
CanChangeInfo bool `json:"can_change_info"`
CanInviteUsers bool `json:"can_invite_users"`
CanPostMessages bool `json:"can_post_messages"`
CanEditMessages bool `json:"can_edit_messages"`
CanPinMessages bool `json:"can_pin_messages"`
2022-11-06 00:32:26 +01:00
CanManageTopics bool `json:"can_manage_topics"`
2022-04-16 18:36:59 +02:00
}
2020-11-06 05:29:48 +01:00
// ChatMember contains information about one member of a chat.
2016-05-22 17:16:28 +02:00
type ChatMember struct {
2020-11-06 05:29:48 +01:00
// 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
2022-08-07 00:55:52 +02:00
IsAnonymous bool `json:"is_anonymous,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2021-03-09 18:27:17 +01:00
// 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 supergroups and ignore slow mode. Implied by
2021-03-09 18:27:17 +01:00
// any other administrator privilege.
//
// optional
2022-08-07 00:55:52 +02:00
CanManageChat bool `json:"can_manage_chat,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2022-04-16 18:36:59 +02:00
// CanManageVideoChats administrators only.
// True, if the administrator can manage video chats.
2021-03-09 18:27:17 +01:00
//
// optional
2022-08-07 00:55:52 +02:00
CanManageVideoChats bool `json:"can_manage_video_chats,omitempty"`
2020-11-06 05:29:48 +01:00
// 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
2022-12-31 01:15:29 +01:00
CanPinMessages bool `json:"can_pin_messages,omitempty"`
2022-11-06 00:32:26 +01:00
// CanManageTopics administrators and restricted only.
2022-12-31 01:15:29 +01:00
// True, if the user is allowed to create, rename,
2022-11-06 00:32:26 +01:00
// close, and reopen forum topics; supergroups only
//
// optional
CanManageTopics bool `json:"can_manage_topics,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2023-02-04 03:53:55 +01:00
// CanSendAudios restricted only.
// True, if the user is allowed to send audios
//
// optional
CanSendAudios bool
// CanSendDocuments restricted only.
// True, if the user is allowed to send documents
//
// optional
CanSendDocuments bool
// CanSendPhotos is restricted only.
// True, if the user is allowed to send photos
2020-11-06 05:29:48 +01:00
//
// optional
2023-02-04 03:53:55 +01:00
CanSendPhotos bool
// CanSendVideos restricted only.
// True, if the user is allowed to send videos
//
// optional
CanSendVideos bool
// CanSendVideoNotes restricted only.
// True, if the user is allowed to send video notes
//
// optional
CanSendVideoNotes bool
// CanSendVoiceNotes restricted only.
// True, if the user is allowed to send voice notes
//
// optional
CanSendVoiceNotes bool
2020-11-06 05:29:48 +01:00
// 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"`
2016-05-22 17:16:28 +02:00
}
// 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" }
2023-02-04 03:53:55 +01:00
// SetCanSendMediaMessages is a method to replace field "can_send_media_messages".
// It sets CanSendAudio, CanSendDocuments, CanSendPhotos, CanSendVideos,
// CanSendVideoNotes, CanSendVoiceNotes to passed value.
func (chat *ChatMember) SetCanSendMediaMessages(b bool) {
chat.CanSendAudios = b
chat.CanSendDocuments = b
chat.CanSendPhotos = b
chat.CanSendVideos = b
chat.CanSendVideoNotes = b
chat.CanSendVoiceNotes = b
}
// CanSendMediaMessages method to replace field "can_send_media_messages".
// It returns true if CanSendAudio and CanSendDocuments and CanSendPhotos and CanSendVideos and
// CanSendVideoNotes and CanSendVoiceNotes are true.
func (chat *ChatMember) CanSendMediaMessages() bool {
return chat.CanSendAudios && chat.CanSendDocuments &&
chat.CanSendPhotos && chat.CanSendVideos &&
chat.CanSendVideoNotes && chat.CanSendVoiceNotes
}
2021-03-09 18:27:17 +01:00
// 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
2022-08-07 00:55:52 +02:00
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
}
2021-11-08 20:17:17 +01:00
// 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.
2021-12-13 12:19:11 +01:00
From User `json:"from"`
2023-02-04 03:53:55 +01:00
// UserChatID identifier of a private chat with the user who sent the join request.
UserChatID int64 `json:"user_chat_id"`
2021-11-08 20:17:17 +01:00
// Date the request was sent in Unix time.
Date int `json:"date"`
// Bio of the user.
//
// optional
2022-08-07 00:55:52 +02:00
Bio string `json:"bio,omitempty"`
2021-11-08 20:17:17 +01:00
// InviteLink is the link that was used by the user to send the join request.
//
// optional
2022-08-07 00:55:52 +02:00
InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
2021-11-08 20:17:17 +01:00
}
2020-11-06 05:29:48 +01:00
// 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"`
2023-02-04 03:53:55 +01:00
// CanSendAudios is true, if the user is allowed to send audios
//
// optional
CanSendAudios bool
// CanSendDocuments is true, if the user is allowed to send documents
//
// optional
CanSendDocuments bool
// CanSendPhotos is true, if the user is allowed to send photos
2020-11-06 05:29:48 +01:00
//
// optional
2023-02-04 03:53:55 +01:00
CanSendPhotos bool
// CanSendVideos is true, if the user is allowed to send videos
//
// optional
CanSendVideos bool
// CanSendVideoNotes is true, if the user is allowed to send video notes
//
// optional
CanSendVideoNotes bool
// CanSendVoiceNotes is true, if the user is allowed to send voice notes
//
// optional
CanSendVoiceNotes bool
2020-11-06 05:29:48 +01:00
// 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"`
2022-11-06 00:32:26 +01:00
// CanManageTopics is true, if the user is allowed to create forum topics.
// If omitted defaults to the value of can_pin_messages
//
// optional
CanManageTopics bool `json:"can_manage_topics,omitempty"`
}
2023-02-04 03:53:55 +01:00
// SetCanSendMediaMessages is a method to replace field "can_send_media_messages".
// It sets CanSendAudio, CanSendDocuments, CanSendPhotos, CanSendVideos,
// CanSendVideoNotes, CanSendVoiceNotes to passed value.
func (c *ChatPermissions) SetCanSendMediaMessages(b bool) {
c.CanSendAudios = b
c.CanSendDocuments = b
c.CanSendPhotos = b
c.CanSendVideos = b
c.CanSendVideoNotes = b
c.CanSendVoiceNotes = b
}
// CanSendMediaMessages method to replace field "can_send_media_messages".
// It returns true if CanSendAudio and CanSendDocuments and CanSendPhotos and CanSendVideos and
// CanSendVideoNotes and CanSendVoiceNotes are true.
func (c *ChatPermissions) CanSendMediaMessages() bool {
return c.CanSendAudios && c.CanSendDocuments &&
c.CanSendPhotos && c.CanSendVideos &&
c.CanSendVideoNotes && c.CanSendVoiceNotes
}
// 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"`
}
2022-11-06 00:32:26 +01:00
// ForumTopic represents a forum topic.
type ForumTopic struct {
// MessageThreadID is the unique identifier of the forum topic
MessageThreadID int `json:"message_thread_id"`
// Name is the name of the topic
Name string `json:"name"`
// IconColor is the color of the topic icon in RGB format
IconColor int `json:"icon_color"`
// IconCustomEmojiID is the unique identifier of the custom emoji
// shown as the topic icon
//
// optional
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
}
2020-11-06 05:29:48 +01:00
// 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"`
}
2021-06-27 21:15:09 +02:00
// 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"`
}
2023-07-04 21:21:43 +02:00
// BotDescription represents the bot's description.
type BotDescription struct {
Description string `json:"description"`
}
// BotShortDescription represents the bot's short description
type BotShortDescription struct {
ShortDescription string `json:"short_description"`
}
2022-04-16 18:36:59 +02:00
// MenuButton describes the bot's menu button in a private chat.
type MenuButton struct {
// Type is the type of menu button, must be one of:
// - `commands`
// - `web_app`
// - `default`
Type string `json:"type"`
// Text is the text on the button, for `web_app` type.
Text string `json:"text,omitempty"`
// WebApp is the description of the Web App that will be launched when the
// user presses the button for the `web_app` type.
WebApp *WebAppInfo `json:"web_app,omitempty"`
}
2020-11-06 05:29:48 +01:00
// 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://<file_attach_name>” to upload a new one
// using multipart/form-data under <file_attach_name> name.
2021-08-20 21:31:52 +02:00
Media RequestFileData `json:"media"`
2020-11-06 05:29:48 +01:00
// 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
2022-08-07 00:55:52 +02:00
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
2022-12-31 01:15:29 +01:00
// HasSpoiler pass True, if the photo needs to be covered with a spoiler animation
//
// optional
HasSpoiler bool `json:"has_spoiler,omitempty"`
2020-11-06 05:29:48 +01:00
}
// 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
2023-07-04 21:21:43 +02:00
Thumb RequestFileData `json:"thumbnail,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2022-12-31 01:15:29 +01:00
// HasSpoiler pass True, if the video needs to be covered with a spoiler animation
//
// optional
HasSpoiler bool `json:"has_spoiler,omitempty"`
2020-11-06 05:29:48 +01:00
}
// 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
2023-07-04 21:21:43 +02:00
Thumb RequestFileData `json:"thumbnail,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2022-12-31 01:15:29 +01:00
// HasSpoiler pass True, if the photo needs to be covered with a spoiler animation
//
// optional
HasSpoiler bool `json:"has_spoiler,omitempty"`
2020-11-06 05:29:48 +01:00
}
// InputMediaAudio is an audio to send as part of a media group.
2020-11-06 05:29:48 +01:00
type InputMediaAudio struct {
BaseInputMedia
// Thumbnail of the file sent; can be ignored if thumbnail generation for
// the file is supported server-side.
//
// optional
2023-07-04 21:21:43 +02:00
Thumb RequestFileData `json:"thumbnail,omitempty"`
2020-11-06 05:29:48 +01:00
// 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
2023-07-04 21:21:43 +02:00
Thumb RequestFileData `json:"thumbnail,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"`
2020-11-06 05:29:48 +01:00
}
2022-11-20 20:55:30 +01:00
// Constant values for sticker types
const (
StickerTypeRegular = "regular"
StickerTypeMask = "mask"
StickerTypeCustomEmoji = "custom_emoji"
)
2020-11-06 05:29:48 +01:00
// 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 a unique identifier for this file,
2020-11-06 05:29:48 +01:00
// 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"`
2022-11-20 20:55:30 +01:00
// Type is a type of the sticker, currently one of “regular”,
// “mask”, “custom_emoji”. The type of the sticker is independent
// from its format, which is determined by the fields is_animated and is_video.
Type string `json:"type"`
2020-11-06 05:29:48 +01:00
// 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"`
2022-09-25 14:50:54 +02:00
// IsVideo true, if the sticker is a video sticker
//
// optional
IsVideo bool `json:"is_video,omitempty"`
2020-11-06 05:29:48 +01:00
// Thumbnail sticker thumbnail in the .WEBP or .JPG format
//
// optional
2023-07-04 21:21:43 +02:00
Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2022-09-25 14:50:54 +02:00
// PremiumAnimation for premium regular stickers, premium animation for the sticker
//
// optional
PremiumAnimation *File `json:"premium_animation,omitempty"`
2020-11-06 05:29:48 +01:00
// MaskPosition is for mask stickers, the position where the mask should be
// placed
//
// optional
MaskPosition *MaskPosition `json:"mask_position,omitempty"`
2022-09-25 14:50:54 +02:00
// CustomEmojiID for custom emoji stickers, unique identifier of the custom emoji
//
// optional
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
2023-07-04 21:21:43 +02:00
// NeedsRepainting True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places
//
//optional
NeedsRepainting bool `json:"needs_reainting,omitempty"`
2020-11-06 05:29:48 +01:00
// FileSize
//
// optional
FileSize int `json:"file_size,omitempty"`
}
2022-11-20 20:55:30 +01:00
// IsRegular returns if the Sticker is regular
func (s Sticker) IsRegular() bool {
return s.Type == StickerTypeRegular
}
// IsMask returns if the Sticker is mask
func (s Sticker) IsMask() bool {
return s.Type == StickerTypeMask
}
// IsCustomEmoji returns if the Sticker is custom emoji
func (s Sticker) IsCustomEmoji() bool {
return s.Type == StickerTypeCustomEmoji
}
2020-11-06 05:29:48 +01:00
// StickerSet represents a sticker set.
type StickerSet struct {
// Name sticker set name
Name string `json:"name"`
// Title sticker set title
Title string `json:"title"`
2022-09-25 14:50:54 +02:00
// StickerType of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”
StickerType string `json:"sticker_type"`
2020-11-06 05:29:48 +01:00
// IsAnimated true, if the sticker set contains animated stickers
IsAnimated bool `json:"is_animated"`
2022-09-25 14:50:54 +02:00
// IsVideo true, if the sticker set contains video stickers
IsVideo bool `json:"is_video"`
2020-11-06 05:29:48 +01:00
// ContainsMasks true, if the sticker set contains masks
2022-11-20 20:55:30 +01:00
//
// deprecated. Use sticker_type instead
2020-11-06 05:29:48 +01:00
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
2023-07-04 21:21:43 +02:00
Thumbnail *PhotoSize `json:"thumbnail"`
2020-11-06 05:29:48 +01:00
}
2022-11-20 20:55:30 +01:00
// IsRegular returns if the StickerSet is regular
func (s StickerSet) IsRegular() bool {
return s.StickerType == StickerTypeRegular
}
// IsMask returns if the StickerSet is mask
func (s StickerSet) IsMask() bool {
return s.StickerType == StickerTypeMask
}
// IsCustomEmoji returns if the StickerSet is custom emoji
func (s StickerSet) IsCustomEmoji() bool {
return s.StickerType == StickerTypeCustomEmoji
}
2020-11-06 05:29:48 +01:00
// 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"`
}
2023-07-04 21:21:43 +02:00
// InputSticker describes a sticker to be added to a sticker set.
type InputSticker struct {
// The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL.
Sticker RequestFile `json:"sticker"`
// List of 1-20 emoji associated with the sticker
EmojiList []string `json:"emoji_list"`
// Position where the mask should be placed on faces. For “mask” stickers only.
//
// optional
MaskPosition *MaskPosition `json:"mask_position"`
// List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only.
//
// optional
Keywords []string `json:"keywords"`
}
2020-11-06 05:29:48 +01:00
// 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 is an animation that will be displayed in the game message in chats.
2020-11-06 05:29:48 +01:00
// 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 {
2020-11-06 05:29:48 +01:00
// 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 {
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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"`
2022-04-16 18:36:59 +02:00
// LastSynchronizationErrorDate is the unix time of the most recent error that
// happened when trying to synchronize available updates with Telegram datacenters.
LastSynchronizationErrorDate int `json:"last_synchronization_error_date,omitempty"`
2020-11-06 05:29:48 +01:00
// 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 {
2020-11-06 05:29:48 +01:00
// 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
2022-08-07 00:55:52 +02:00
ChatType string `json:"chat_type,omitempty"`
// Location sender location, only for bots that request user location.
//
// optional
Location *Location `json:"location,omitempty"`
}
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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"`
}
2020-11-06 05:29:48 +01:00
// InlineQueryResultCachedDocument is an inline query response with cached document.
type InlineQueryResultCachedDocument struct {
// Type of the result, must be a document
2020-11-06 05:29:48 +01:00
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"`
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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 {
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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"`
}
2020-11-06 05:29:48 +01:00
// InlineQueryResultCachedMPEG4GIF is an inline query response with cached
// H.264/MPEG-4 AVC video without sound gif.
2020-11-06 05:29:48 +01:00
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
2020-11-06 05:29:48 +01:00
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"`
2020-11-06 05:29:48 +01:00
// 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"`
}
2020-11-06 05:29:48 +01:00
// InlineQueryResultCachedPhoto is an inline query response with cached photo.
type InlineQueryResultCachedPhoto struct {
// Type of the result, must be a photo.
2020-11-06 05:29:48 +01:00
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"`
2020-11-06 05:29:48 +01:00
// 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 a sticker
2020-11-06 05:29:48 +01:00
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"`
}
2016-01-04 17:15:57 +01:00
// InlineQueryResultCachedVideo is an inline query response with cached video.
type InlineQueryResultCachedVideo struct {
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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 {
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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"`
}
2020-11-06 05:29:48 +01:00
// 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
2023-07-04 21:21:43 +02:00
ThumbURL string `json:"thumbnail_url,omitempty"`
2020-11-06 05:29:48 +01:00
// ThumbWidth thumbnail width
//
// optional
2023-07-04 21:21:43 +02:00
ThumbWidth int `json:"thumbnail_width,omitempty"`
2020-11-06 05:29:48 +01:00
// ThumbHeight thumbnail height
//
// optional
2023-07-04 21:21:43 +02:00
ThumbHeight int `json:"thumbnail_height,omitempty"`
}
// InlineQueryResultAudio is an inline query response audio.
type InlineQueryResultAudio struct {
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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"`
2016-04-13 16:30:52 +02:00
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
InputMessageContent interface{} `json:"input_message_content,omitempty"`
2023-07-04 21:21:43 +02:00
ThumbURL string `json:"thumbnail_url"`
ThumbWidth int `json:"thumbnail_width"`
ThumbHeight int `json:"thumbnail_height"`
}
2020-11-06 05:29:48 +01:00
// 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 a document
2020-11-06 05:29:48 +01:00
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 inline keyboard attached to the message
2020-11-06 05:29:48 +01:00
//
// 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
2023-07-04 21:21:43 +02:00
ThumbURL string `json:"thumbnail_url,omitempty"`
2020-11-06 05:29:48 +01:00
// ThumbWidth thumbnail width
//
// optional
2023-07-04 21:21:43 +02:00
ThumbWidth int `json:"thumbnail_width,omitempty"`
2020-11-06 05:29:48 +01:00
// ThumbHeight thumbnail height
//
// optional
2023-07-04 21:21:43 +02:00
ThumbHeight int `json:"thumbnail_height,omitempty"`
}
2020-11-06 05:29:48 +01:00
// 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.
2023-07-04 21:21:43 +02:00
ThumbURL string `json:"thumbnail_url"`
// MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”
ThumbMimeType string `json:"thumbnail_mime_type,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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 {
2020-11-06 05:29:48 +01:00
// 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
2022-08-07 00:55:52 +02:00
HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`
// LivePeriod is the period in seconds for which the location can be
// updated, should be between 60 and 86400.
//
// optional
2022-08-07 00:55:52 +02:00
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
2022-08-07 00:55:52 +02:00
Heading int `json:"heading,omitempty"`
// 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
2022-08-07 00:55:52 +02:00
ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
2020-11-06 05:29:48 +01:00
// 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
2023-07-04 21:21:43 +02:00
ThumbURL string `json:"thumbnail_url,omitempty"`
2020-11-06 05:29:48 +01:00
// ThumbWidth thumbnail width
//
// optional
2023-07-04 21:21:43 +02:00
ThumbWidth int `json:"thumbnail_width,omitempty"`
2020-11-06 05:29:48 +01:00
// ThumbHeight thumbnail height
//
// optional
2023-07-04 21:21:43 +02:00
ThumbHeight int `json:"thumbnail_height,omitempty"`
}
2020-11-06 05:29:48 +01:00
// 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
2022-08-07 00:55:52 +02:00
Width int `json:"mpeg4_width,omitempty"`
2020-11-06 05:29:48 +01:00
// Height vVideo height
//
// optional
2022-08-07 00:55:52 +02:00
Height int `json:"mpeg4_height,omitempty"`
2020-11-06 05:29:48 +01:00
// Duration video duration
//
// optional
2022-08-07 00:55:52 +02:00
Duration int `json:"mpeg4_duration,omitempty"`
2020-11-06 05:29:48 +01:00
// ThumbURL url of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result.
2023-07-04 21:21:43 +02:00
ThumbURL string `json:"thumbnail_url"`
// MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”
ThumbMimeType string `json:"thumbnail_mime_type,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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
2023-07-04 21:21:43 +02:00
ThumbURL string `json:"thumbnail_url,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// InputMessageContent content of the message to be sent instead of the photo.
//
// optional
InputMessageContent interface{} `json:"input_message_content,omitempty"`
}
2020-01-06 17:28:13 +01:00
// InlineQueryResultVenue is an inline query response venue.
type InlineQueryResultVenue struct {
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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
2023-07-04 21:21:43 +02:00
ThumbURL string `json:"thumbnail_url,omitempty"`
2020-11-06 05:29:48 +01:00
// ThumbWidth thumbnail width
//
// optional
2023-07-04 21:21:43 +02:00
ThumbWidth int `json:"thumbnail_width,omitempty"`
2020-11-06 05:29:48 +01:00
// ThumbHeight thumbnail height
//
// optional
2023-07-04 21:21:43 +02:00
ThumbHeight int `json:"thumbnail_height,omitempty"`
2020-01-06 17:28:13 +01:00
}
2020-11-06 05:29:48 +01:00
// 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
2023-07-04 21:21:43 +02:00
ThumbURL string `json:"thumbnail_url,omitempty"`
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// 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"`
}
2016-01-04 17:15:57 +01:00
// ChosenInlineResult is an inline query result chosen by a User
type ChosenInlineResult struct {
2020-11-06 05:29:48 +01:00
// 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"`
2016-01-04 17:15:57 +01:00
}
2022-04-16 18:36:59 +02:00
// SentWebAppMessage contains information about an inline message sent by a Web App
// on behalf of a user.
type SentWebAppMessage struct {
// Identifier of the sent inline message. Available only if there is an inline
// keyboard attached to the message.
//
// optional
2022-08-07 00:55:52 +02:00
InlineMessageID string `json:"inline_message_id,omitempty"`
2022-04-16 18:36:59 +02:00
}
2016-04-12 15:59:47 +02:00
// InputTextMessageContent contains text for displaying
// as an inline query result.
type InputTextMessageContent struct {
2020-11-06 05:29:48 +01:00
// 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"`
2020-11-06 05:29:48 +01:00
// DisableWebPagePreview disables link previews for links in the sent message
//
// optional
DisableWebPagePreview bool `json:"disable_web_page_preview,omitempty"`
}
2016-04-12 15:59:47 +02:00
// InputLocationMessageContent contains a location for displaying
// as an inline query result.
type InputLocationMessageContent struct {
2020-11-06 05:29:48 +01:00
// 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
2022-08-07 00:55:52 +02:00
HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`
2020-11-06 05:29:48 +01:00
// 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
2022-08-07 00:55:52 +02:00
Heading int `json:"heading,omitempty"`
// 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
2022-08-07 00:55:52 +02:00
ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
}
2016-04-12 15:59:47 +02:00
// InputVenueMessageContent contains a venue for displaying
// as an inline query result.
type InputVenueMessageContent struct {
2020-11-06 05:29:48 +01:00
// 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
2022-08-07 00:55:52 +02:00
GooglePlaceID string `json:"google_place_id,omitempty"`
// GooglePlaceType is the Google Places type of the venue
//
// optional
2022-08-07 00:55:52 +02:00
GooglePlaceType string `json:"google_place_type,omitempty"`
}
2016-04-12 15:59:47 +02:00
// InputContactMessageContent contains a contact for displaying
// as an inline query result.
type InputContactMessageContent struct {
2020-11-06 05:29:48 +01:00
// PhoneNumber contact's phone number
PhoneNumber string `json:"phone_number"`
2020-11-06 05:29:48 +01:00
// 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"`
}
2020-11-06 05:29:48 +01:00
// 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"`
}
2017-06-02 22:18:42 +02:00
2017-06-03 08:59:40 +02:00
// Invoice contains basic information about an invoice.
2017-06-02 22:18:42 +02:00
type Invoice struct {
2020-11-06 05:29:48 +01:00
// 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
2017-06-02 22:18:42 +02:00
StartParameter string `json:"start_parameter"`
2020-11-06 05:29:48 +01:00
// 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"`
2017-06-02 22:18:42 +02:00
}
2017-06-03 08:59:40 +02:00
// ShippingAddress represents a shipping address.
2017-06-02 22:18:42 +02:00
type ShippingAddress struct {
2020-11-06 05:29:48 +01:00
// CountryCode ISO 3166-1 alpha-2 country code
2017-06-02 22:18:42 +02:00
CountryCode string `json:"country_code"`
2020-11-06 05:29:48 +01:00
// State if applicable
State string `json:"state"`
// City city
City string `json:"city"`
// StreetLine1 first line for the address
2017-06-02 22:18:42 +02:00
StreetLine1 string `json:"street_line1"`
2020-11-06 05:29:48 +01:00
// StreetLine2 second line for the address
2017-06-02 22:18:42 +02:00
StreetLine2 string `json:"street_line2"`
2020-11-06 05:29:48 +01:00
// PostCode address post code
PostCode string `json:"post_code"`
2017-06-02 22:18:42 +02:00
}
2017-06-03 08:59:40 +02:00
// OrderInfo represents information about an order.
2017-06-02 22:18:42 +02:00
type OrderInfo struct {
2020-11-06 05:29:48 +01:00
// 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
2017-06-02 22:18:42 +02:00
ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"`
}
2017-06-03 08:59:40 +02:00
// ShippingOption represents one shipping option.
2017-06-02 22:18:42 +02:00
type ShippingOption struct {
2020-11-06 05:29:48 +01:00
// ID shipping option identifier
ID string `json:"id"`
// Title option title
Title string `json:"title"`
// Prices list of price portions
2018-10-09 06:32:34 +02:00
Prices []LabeledPrice `json:"prices"`
2017-06-02 22:18:42 +02:00
}
2017-06-03 08:59:40 +02:00
// SuccessfulPayment contains basic information about a successful payment.
2017-06-02 22:18:42 +02:00
type SuccessfulPayment struct {
2020-11-06 05:29:48 +01:00
// 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"`
2017-06-02 22:18:42 +02:00
}
2017-06-03 08:59:40 +02:00
// ShippingQuery contains information about an incoming shipping query.
2017-06-02 22:18:42 +02:00
type ShippingQuery struct {
2020-11-06 05:29:48 +01:00
// 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
2017-06-02 22:18:42 +02:00
ShippingAddress *ShippingAddress `json:"shipping_address"`
}
2017-06-03 08:59:40 +02:00
// PreCheckoutQuery contains information about an incoming pre-checkout query.
2017-06-02 22:18:42 +02:00
type PreCheckoutQuery struct {
2020-11-06 05:29:48 +01:00
// 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"`
}