types.go (view raw)
1package tgbotapi
2
3import (
4 "encoding/json"
5 "errors"
6 "fmt"
7 "net/url"
8 "strings"
9 "time"
10)
11
12// APIResponse is a response from the Telegram API with the result
13// stored raw.
14type APIResponse struct {
15 Ok bool `json:"ok"`
16 Result json.RawMessage `json:"result"`
17 ErrorCode int `json:"error_code"`
18 Description string `json:"description"`
19 Parameters *ResponseParameters `json:"parameters"`
20}
21
22// ResponseParameters are various errors that can be returned in APIResponse.
23type ResponseParameters struct {
24 MigrateToChatID int64 `json:"migrate_to_chat_id"` // optional
25 RetryAfter int `json:"retry_after"` // optional
26}
27
28// Update is an update response, from GetUpdates.
29type Update struct {
30 UpdateID int `json:"update_id"`
31 Message *Message `json:"message"`
32 EditedMessage *Message `json:"edited_message"`
33 ChannelPost *Message `json:"channel_post"`
34 EditedChannelPost *Message `json:"edited_channel_post"`
35 InlineQuery *InlineQuery `json:"inline_query"`
36 ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result"`
37 CallbackQuery *CallbackQuery `json:"callback_query"`
38 ShippingQuery *ShippingQuery `json:"shipping_query"`
39 PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query"`
40}
41
42// UpdatesChannel is the channel for getting updates.
43type UpdatesChannel <-chan Update
44
45// Clear discards all unprocessed incoming updates.
46func (ch UpdatesChannel) Clear() {
47 for len(ch) != 0 {
48 <-ch
49 }
50}
51
52// User is a user on Telegram.
53type User struct {
54 ID int `json:"id"`
55 FirstName string `json:"first_name"`
56 LastName string `json:"last_name"` // optional
57 UserName string `json:"username"` // optional
58 LanguageCode string `json:"language_code"` // optional
59 IsBot bool `json:"is_bot"` // optional
60}
61
62// String displays a simple text version of a user.
63//
64// It is normally a user's username, but falls back to a first/last
65// name as available.
66func (u *User) String() string {
67 if u == nil {
68 return ""
69 }
70 if u.UserName != "" {
71 return u.UserName
72 }
73
74 name := u.FirstName
75 if u.LastName != "" {
76 name += " " + u.LastName
77 }
78
79 return name
80}
81
82// GroupChat is a group chat.
83type GroupChat struct {
84 ID int `json:"id"`
85 Title string `json:"title"`
86}
87
88// ChatPhoto represents a chat photo.
89type ChatPhoto struct {
90 SmallFileID string `json:"small_file_id"`
91 BigFileID string `json:"big_file_id"`
92}
93
94// Chat contains information about the place a message was sent.
95type Chat struct {
96 ID int64 `json:"id"`
97 Type string `json:"type"`
98 Title string `json:"title"` // optional
99 UserName string `json:"username"` // optional
100 FirstName string `json:"first_name"` // optional
101 LastName string `json:"last_name"` // optional
102 AllMembersAreAdmins bool `json:"all_members_are_administrators"` // optional
103 Photo *ChatPhoto `json:"photo"`
104 Description string `json:"description,omitempty"` // optional
105 InviteLink string `json:"invite_link,omitempty"` // optional
106 PinnedMessage *Message `json:"pinned_message"` // optional
107}
108
109// IsPrivate returns if the Chat is a private conversation.
110func (c Chat) IsPrivate() bool {
111 return c.Type == "private"
112}
113
114// IsGroup returns if the Chat is a group.
115func (c Chat) IsGroup() bool {
116 return c.Type == "group"
117}
118
119// IsSuperGroup returns if the Chat is a supergroup.
120func (c Chat) IsSuperGroup() bool {
121 return c.Type == "supergroup"
122}
123
124// IsChannel returns if the Chat is a channel.
125func (c Chat) IsChannel() bool {
126 return c.Type == "channel"
127}
128
129// ChatConfig returns a ChatConfig struct for chat related methods.
130func (c Chat) ChatConfig() ChatConfig {
131 return ChatConfig{ChatID: c.ID}
132}
133
134// Message is returned by almost every request, and contains data about
135// almost anything.
136type Message struct {
137 // MessageID is a unique message identifier inside this chat
138 MessageID int `json:"message_id"`
139 // From is a sender, empty for messages sent to channels;
140 // optional
141 From *User `json:"from"`
142 // Date of the message was sent in Unix time
143 Date int `json:"date"`
144 // Chat is the conversation the message belongs to
145 Chat *Chat `json:"chat"`
146 // ForwardFrom for forwarded messages, sender of the original message;
147 // optional
148 ForwardFrom *User `json:"forward_from"`
149 // ForwardFromChat for messages forwarded from channels,
150 // information about the original channel;
151 // optional
152 ForwardFromChat *Chat `json:"forward_from_chat"`
153 // ForwardFromMessageID for messages forwarded from channels,
154 // identifier of the original message in the channel;
155 // optional
156 ForwardFromMessageID int `json:"forward_from_message_id"`
157 // ForwardDate for forwarded messages, date the original message was sent in Unix time;
158 // optional
159 ForwardDate int `json:"forward_date"`
160 // ReplyToMessage for replies, the original message.
161 // Note that the Message object in this field will not contain further ReplyToMessage fields
162 // even if it itself is a reply;
163 // optional
164 ReplyToMessage *Message `json:"reply_to_message"`
165 // ViaBot through which the message was sent;
166 // optional
167 ViaBot *User `json:"via_bot"`
168 // EditDate of the message was last edited in Unix time;
169 // optional
170 EditDate int `json:"edit_date"`
171 // MediaGroupID is the unique identifier of a media message group this message belongs to;
172 // optional
173 MediaGroupID string `json:"media_group_id"`
174 // AuthorSignature is the signature of the post author for messages in channels;
175 // optional
176 AuthorSignature string `json:"author_signature"`
177 // Text is for text messages, the actual UTF-8 text of the message, 0-4096 characters;
178 // optional
179 Text string `json:"text"`
180 // Entities is for text messages, special entities like usernames,
181 // URLs, bot commands, etc. that appear in the text;
182 // optional
183 Entities *[]MessageEntity `json:"entities"`
184 // CaptionEntities;
185 // optional
186 CaptionEntities *[]MessageEntity `json:"caption_entities"`
187 // Audio message is an audio file, information about the file;
188 // optional
189 Audio *Audio `json:"audio"`
190 // Document message is a general file, information about the file;
191 // optional
192 Document *Document `json:"document"`
193 // Animation message is an animation, information about the animation.
194 // For backward compatibility, when this field is set, the document field will also be set;
195 // optional
196 Animation *ChatAnimation `json:"animation"`
197 // Game message is a game, information about the game;
198 // optional
199 Game *Game `json:"game"`
200 // Photo message is a photo, available sizes of the photo;
201 // optional
202 Photo *[]PhotoSize `json:"photo"`
203 // Sticker message is a sticker, information about the sticker;
204 // optional
205 Sticker *Sticker `json:"sticker"`
206 // Video message is a video, information about the video;
207 // optional
208 Video *Video `json:"video"`
209 // VideoNote message is a video note, information about the video message;
210 // optional
211 VideoNote *VideoNote `json:"video_note"`
212 // Voice message is a voice message, information about the file;
213 // optional
214 Voice *Voice `json:"voice"`
215 // Caption for the animation, audio, document, photo, video or voice, 0-1024 characters;
216 // optional
217 Caption string `json:"caption"`
218 // Contact message is a shared contact, information about the contact;
219 // optional
220 Contact *Contact `json:"contact"`
221 // Location message is a shared location, information about the location;
222 // optional
223 Location *Location `json:"location"`
224 // Venue message is a venue, information about the venue.
225 // For backward compatibility, when this field is set, the location field will also be set;
226 // optional
227 Venue *Venue `json:"venue"`
228 // NewChatMembers that were added to the group or supergroup
229 // and information about them (the bot itself may be one of these members);
230 // optional
231 NewChatMembers *[]User `json:"new_chat_members"`
232 // LeftChatMember is a member was removed from the group,
233 // information about them (this member may be the bot itself);
234 // optional
235 LeftChatMember *User `json:"left_chat_member"`
236 // NewChatTitle is a chat title was changed to this value;
237 // optional
238 NewChatTitle string `json:"new_chat_title"`
239 // NewChatPhoto is a chat photo was change to this value;
240 // optional
241 NewChatPhoto *[]PhotoSize `json:"new_chat_photo"`
242 // DeleteChatPhoto is a service message: the chat photo was deleted;
243 // optional
244 DeleteChatPhoto bool `json:"delete_chat_photo"`
245 // GroupChatCreated is a service message: the group has been created;
246 // optional
247 GroupChatCreated bool `json:"group_chat_created"`
248 // SuperGroupChatCreated is a service message: the supergroup has been created.
249 // This field can't be received in a message coming through updates,
250 // because bot can't be a member of a supergroup when it is created.
251 // It can only be found in ReplyToMessage if someone replies to a very first message
252 // in a directly created supergroup;
253 // optional
254 SuperGroupChatCreated bool `json:"supergroup_chat_created"`
255 // ChannelChatCreated is a service message: the channel has been created.
256 // This field can't be received in a message coming through updates,
257 // because bot can't be a member of a channel when it is created.
258 // It can only be found in ReplyToMessage
259 // if someone replies to a very first message in a channel;
260 // optional
261 ChannelChatCreated bool `json:"channel_chat_created"`
262 // MigrateToChatID is the group has been migrated to a supergroup with the specified identifier.
263 // This number may be greater than 32 bits and some programming languages
264 // may have difficulty/silent defects in interpreting it.
265 // But it is smaller than 52 bits, so a signed 64 bit integer
266 // or double-precision float type are safe for storing this identifier;
267 // optional
268 MigrateToChatID int64 `json:"migrate_to_chat_id"`
269 // MigrateFromChatID is the supergroup has been migrated from a group with the specified identifier.
270 // This number may be greater than 32 bits and some programming languages
271 // may have difficulty/silent defects in interpreting it.
272 // But it is smaller than 52 bits, so a signed 64 bit integer
273 // or double-precision float type are safe for storing this identifier;
274 // optional
275 MigrateFromChatID int64 `json:"migrate_from_chat_id"`
276 // PinnedMessage is a specified message was pinned.
277 // Note that the Message object in this field will not contain further ReplyToMessage
278 // fields even if it is itself a reply;
279 // optional
280 PinnedMessage *Message `json:"pinned_message"`
281 // Invoice message is an invoice for a payment;
282 // optional
283 Invoice *Invoice `json:"invoice"`
284 // SuccessfulPayment message is a service message about a successful payment,
285 // information about the payment;
286 // optional
287 SuccessfulPayment *SuccessfulPayment `json:"successful_payment"`
288 // PassportData is a Telegram Passport data;
289 // optional
290 PassportData *PassportData `json:"passport_data,omitempty"`
291}
292
293// Time converts the message timestamp into a Time.
294func (m *Message) Time() time.Time {
295 return time.Unix(int64(m.Date), 0)
296}
297
298// IsCommand returns true if message starts with a "bot_command" entity.
299func (m *Message) IsCommand() bool {
300 if m.Entities == nil || len(*m.Entities) == 0 {
301 return false
302 }
303
304 entity := (*m.Entities)[0]
305 return entity.Offset == 0 && entity.IsCommand()
306}
307
308// Command checks if the message was a command and if it was, returns the
309// command. If the Message was not a command, it returns an empty string.
310//
311// If the command contains the at name syntax, it is removed. Use
312// CommandWithAt() if you do not want that.
313func (m *Message) Command() string {
314 command := m.CommandWithAt()
315
316 if i := strings.Index(command, "@"); i != -1 {
317 command = command[:i]
318 }
319
320 return command
321}
322
323// CommandWithAt checks if the message was a command and if it was, returns the
324// command. If the Message was not a command, it returns an empty string.
325//
326// If the command contains the at name syntax, it is not removed. Use Command()
327// if you want that.
328func (m *Message) CommandWithAt() string {
329 if !m.IsCommand() {
330 return ""
331 }
332
333 // IsCommand() checks that the message begins with a bot_command entity
334 entity := (*m.Entities)[0]
335 return m.Text[1:entity.Length]
336}
337
338// CommandArguments checks if the message was a command and if it was,
339// returns all text after the command name. If the Message was not a
340// command, it returns an empty string.
341//
342// Note: The first character after the command name is omitted:
343// - "/foo bar baz" yields "bar baz", not " bar baz"
344// - "/foo-bar baz" yields "bar baz", too
345// Even though the latter is not a command conforming to the spec, the API
346// marks "/foo" as command entity.
347func (m *Message) CommandArguments() string {
348 if !m.IsCommand() {
349 return ""
350 }
351
352 // IsCommand() checks that the message begins with a bot_command entity
353 entity := (*m.Entities)[0]
354 if len(m.Text) == entity.Length {
355 return "" // The command makes up the whole message
356 }
357
358 return m.Text[entity.Length+1:]
359}
360
361// MessageEntity contains information about data in a Message.
362type MessageEntity struct {
363 Type string `json:"type"`
364 Offset int `json:"offset"`
365 Length int `json:"length"`
366 URL string `json:"url"` // optional
367 User *User `json:"user"` // optional
368}
369
370// ParseURL attempts to parse a URL contained within a MessageEntity.
371func (e MessageEntity) ParseURL() (*url.URL, error) {
372 if e.URL == "" {
373 return nil, errors.New(ErrBadURL)
374 }
375
376 return url.Parse(e.URL)
377}
378
379// IsMention returns true if the type of the message entity is "mention" (@username).
380func (e MessageEntity) IsMention() bool {
381 return e.Type == "mention"
382}
383
384// IsHashtag returns true if the type of the message entity is "hashtag".
385func (e MessageEntity) IsHashtag() bool {
386 return e.Type == "hashtag"
387}
388
389// IsCommand returns true if the type of the message entity is "bot_command".
390func (e MessageEntity) IsCommand() bool {
391 return e.Type == "bot_command"
392}
393
394// IsUrl returns true if the type of the message entity is "url".
395func (e MessageEntity) IsUrl() bool {
396 return e.Type == "url"
397}
398
399// IsEmail returns true if the type of the message entity is "email".
400func (e MessageEntity) IsEmail() bool {
401 return e.Type == "email"
402}
403
404// IsBold returns true if the type of the message entity is "bold" (bold text).
405func (e MessageEntity) IsBold() bool {
406 return e.Type == "bold"
407}
408
409// IsItalic returns true if the type of the message entity is "italic" (italic text).
410func (e MessageEntity) IsItalic() bool {
411 return e.Type == "italic"
412}
413
414// IsCode returns true if the type of the message entity is "code" (monowidth string).
415func (e MessageEntity) IsCode() bool {
416 return e.Type == "code"
417}
418
419// IsPre returns true if the type of the message entity is "pre" (monowidth block).
420func (e MessageEntity) IsPre() bool {
421 return e.Type == "pre"
422}
423
424// IsTextLink returns true if the type of the message entity is "text_link" (clickable text URL).
425func (e MessageEntity) IsTextLink() bool {
426 return e.Type == "text_link"
427}
428
429// PhotoSize contains information about photos.
430type PhotoSize struct {
431 FileID string `json:"file_id"`
432 Width int `json:"width"`
433 Height int `json:"height"`
434 FileSize int `json:"file_size"` // optional
435}
436
437// Audio contains information about audio.
438type Audio struct {
439 FileID string `json:"file_id"`
440 Duration int `json:"duration"`
441 Performer string `json:"performer"` // optional
442 Title string `json:"title"` // optional
443 MimeType string `json:"mime_type"` // optional
444 FileSize int `json:"file_size"` // optional
445}
446
447// Document contains information about a document.
448type Document struct {
449 FileID string `json:"file_id"`
450 Thumbnail *PhotoSize `json:"thumb"` // optional
451 FileName string `json:"file_name"` // optional
452 MimeType string `json:"mime_type"` // optional
453 FileSize int `json:"file_size"` // optional
454}
455
456// Sticker contains information about a sticker.
457type Sticker struct {
458 FileUniqueID string `json:"file_unique_id"`
459 FileID string `json:"file_id"`
460 Width int `json:"width"`
461 Height int `json:"height"`
462 Thumbnail *PhotoSize `json:"thumb"` // optional
463 Emoji string `json:"emoji"` // optional
464 FileSize int `json:"file_size"` // optional
465 SetName string `json:"set_name"` // optional
466 IsAnimated bool `json:"is_animated"` // optional
467}
468
469// StickerSet contains information about an sticker set.
470type StickerSet struct {
471 Name string `json:"name"`
472 Title string `json:"title"`
473 IsAnimated bool `json:"is_animated"`
474 ContainsMasks bool `json:"contains_masks"`
475 Stickers []Sticker `json:"stickers"`
476}
477
478// ChatAnimation contains information about an animation.
479type ChatAnimation struct {
480 FileID string `json:"file_id"`
481 Width int `json:"width"`
482 Height int `json:"height"`
483 Duration int `json:"duration"`
484 Thumbnail *PhotoSize `json:"thumb"` // optional
485 FileName string `json:"file_name"` // optional
486 MimeType string `json:"mime_type"` // optional
487 FileSize int `json:"file_size"` // optional
488}
489
490// Video contains information about a video.
491type Video struct {
492 FileID string `json:"file_id"`
493 Width int `json:"width"`
494 Height int `json:"height"`
495 Duration int `json:"duration"`
496 Thumbnail *PhotoSize `json:"thumb"` // optional
497 MimeType string `json:"mime_type"` // optional
498 FileSize int `json:"file_size"` // optional
499}
500
501// VideoNote contains information about a video.
502type VideoNote struct {
503 FileID string `json:"file_id"`
504 Length int `json:"length"`
505 Duration int `json:"duration"`
506 Thumbnail *PhotoSize `json:"thumb"` // optional
507 FileSize int `json:"file_size"` // optional
508}
509
510// Voice contains information about a voice.
511type Voice struct {
512 FileID string `json:"file_id"`
513 Duration int `json:"duration"`
514 MimeType string `json:"mime_type"` // optional
515 FileSize int `json:"file_size"` // optional
516}
517
518// Contact contains information about a contact.
519//
520// Note that LastName and UserID may be empty.
521type Contact struct {
522 PhoneNumber string `json:"phone_number"`
523 FirstName string `json:"first_name"`
524 LastName string `json:"last_name"` // optional
525 UserID int `json:"user_id"` // optional
526}
527
528// Location contains information about a place.
529type Location struct {
530 Longitude float64 `json:"longitude"`
531 Latitude float64 `json:"latitude"`
532}
533
534// Venue contains information about a venue, including its Location.
535type Venue struct {
536 Location Location `json:"location"`
537 Title string `json:"title"`
538 Address string `json:"address"`
539 FoursquareID string `json:"foursquare_id"` // optional
540}
541
542// UserProfilePhotos contains a set of user profile photos.
543type UserProfilePhotos struct {
544 TotalCount int `json:"total_count"`
545 Photos [][]PhotoSize `json:"photos"`
546}
547
548// File contains information about a file to download from Telegram.
549type File struct {
550 FileID string `json:"file_id"`
551 FileSize int `json:"file_size"` // optional
552 FilePath string `json:"file_path"` // optional
553}
554
555// Link returns a full path to the download URL for a File.
556//
557// It requires the Bot Token to create the link.
558func (f *File) Link(token string) string {
559 return fmt.Sprintf(FileEndpoint, token, f.FilePath)
560}
561
562// ReplyKeyboardMarkup allows the Bot to set a custom keyboard.
563type ReplyKeyboardMarkup struct {
564 Keyboard [][]KeyboardButton `json:"keyboard"`
565 ResizeKeyboard bool `json:"resize_keyboard"` // optional
566 OneTimeKeyboard bool `json:"one_time_keyboard"` // optional
567 Selective bool `json:"selective"` // optional
568}
569
570// KeyboardButton is a button within a custom keyboard.
571type KeyboardButton struct {
572 Text string `json:"text"`
573 RequestContact bool `json:"request_contact"`
574 RequestLocation bool `json:"request_location"`
575}
576
577// ReplyKeyboardHide allows the Bot to hide a custom keyboard.
578type ReplyKeyboardHide struct {
579 HideKeyboard bool `json:"hide_keyboard"`
580 Selective bool `json:"selective"` // optional
581}
582
583// ReplyKeyboardRemove allows the Bot to hide a custom keyboard.
584type ReplyKeyboardRemove struct {
585 RemoveKeyboard bool `json:"remove_keyboard"`
586 Selective bool `json:"selective"`
587}
588
589// InlineKeyboardMarkup is a custom keyboard presented for an inline bot.
590type InlineKeyboardMarkup struct {
591 InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
592}
593
594// InlineKeyboardButton is a button within a custom keyboard for
595// inline query responses.
596//
597// Note that some values are references as even an empty string
598// will change behavior.
599//
600// CallbackGame, if set, MUST be first button in first row.
601type InlineKeyboardButton struct {
602 Text string `json:"text"`
603 URL *string `json:"url,omitempty"` // optional
604 CallbackData *string `json:"callback_data,omitempty"` // optional
605 SwitchInlineQuery *string `json:"switch_inline_query,omitempty"` // optional
606 SwitchInlineQueryCurrentChat *string `json:"switch_inline_query_current_chat,omitempty"` // optional
607 CallbackGame *CallbackGame `json:"callback_game,omitempty"` // optional
608 Pay bool `json:"pay,omitempty"` // optional
609}
610
611// CallbackQuery is data sent when a keyboard button with callback data
612// is clicked.
613type CallbackQuery struct {
614 ID string `json:"id"`
615 From *User `json:"from"`
616 Message *Message `json:"message"` // optional
617 InlineMessageID string `json:"inline_message_id"` // optional
618 ChatInstance string `json:"chat_instance"`
619 Data string `json:"data"` // optional
620 GameShortName string `json:"game_short_name"` // optional
621}
622
623// ForceReply allows the Bot to have users directly reply to it without
624// additional interaction.
625type ForceReply struct {
626 ForceReply bool `json:"force_reply"`
627 Selective bool `json:"selective"` // optional
628}
629
630// ChatMember is information about a member in a chat.
631type ChatMember struct {
632 User *User `json:"user"`
633 Status string `json:"status"`
634 CustomTitle string `json:"custom_title,omitempty"` // optional
635 UntilDate int64 `json:"until_date,omitempty"` // optional
636 CanBeEdited bool `json:"can_be_edited,omitempty"` // optional
637 CanChangeInfo bool `json:"can_change_info,omitempty"` // optional
638 CanPostMessages bool `json:"can_post_messages,omitempty"` // optional
639 CanEditMessages bool `json:"can_edit_messages,omitempty"` // optional
640 CanDeleteMessages bool `json:"can_delete_messages,omitempty"` // optional
641 CanInviteUsers bool `json:"can_invite_users,omitempty"` // optional
642 CanRestrictMembers bool `json:"can_restrict_members,omitempty"` // optional
643 CanPinMessages bool `json:"can_pin_messages,omitempty"` // optional
644 CanPromoteMembers bool `json:"can_promote_members,omitempty"` // optional
645 CanSendMessages bool `json:"can_send_messages,omitempty"` // optional
646 CanSendMediaMessages bool `json:"can_send_media_messages,omitempty"` // optional
647 CanSendOtherMessages bool `json:"can_send_other_messages,omitempty"` // optional
648 CanAddWebPagePreviews bool `json:"can_add_web_page_previews,omitempty"` // optional
649}
650
651// IsCreator returns if the ChatMember was the creator of the chat.
652func (chat ChatMember) IsCreator() bool { return chat.Status == "creator" }
653
654// IsAdministrator returns if the ChatMember is a chat administrator.
655func (chat ChatMember) IsAdministrator() bool { return chat.Status == "administrator" }
656
657// IsMember returns if the ChatMember is a current member of the chat.
658func (chat ChatMember) IsMember() bool { return chat.Status == "member" }
659
660// HasLeft returns if the ChatMember left the chat.
661func (chat ChatMember) HasLeft() bool { return chat.Status == "left" }
662
663// WasKicked returns if the ChatMember was kicked from the chat.
664func (chat ChatMember) WasKicked() bool { return chat.Status == "kicked" }
665
666// Game is a game within Telegram.
667type Game struct {
668 Title string `json:"title"`
669 Description string `json:"description"`
670 Photo []PhotoSize `json:"photo"`
671 Text string `json:"text"`
672 TextEntities []MessageEntity `json:"text_entities"`
673 Animation Animation `json:"animation"`
674}
675
676// Animation is a GIF animation demonstrating the game.
677type Animation struct {
678 FileID string `json:"file_id"`
679 Thumb PhotoSize `json:"thumb"`
680 FileName string `json:"file_name"`
681 MimeType string `json:"mime_type"`
682 FileSize int `json:"file_size"`
683}
684
685// GameHighScore is a user's score and position on the leaderboard.
686type GameHighScore struct {
687 Position int `json:"position"`
688 User User `json:"user"`
689 Score int `json:"score"`
690}
691
692// CallbackGame is for starting a game in an inline keyboard button.
693type CallbackGame struct{}
694
695// WebhookInfo is information about a currently set webhook.
696type WebhookInfo struct {
697 URL string `json:"url"`
698 HasCustomCertificate bool `json:"has_custom_certificate"`
699 PendingUpdateCount int `json:"pending_update_count"`
700 LastErrorDate int `json:"last_error_date"` // optional
701 LastErrorMessage string `json:"last_error_message"` // optional
702 MaxConnections int `json:"max_connections"` // optional
703}
704
705// IsSet returns true if a webhook is currently set.
706func (info WebhookInfo) IsSet() bool {
707 return info.URL != ""
708}
709
710// InputMediaPhoto contains a photo for displaying as part of a media group.
711type InputMediaPhoto struct {
712 Type string `json:"type"`
713 Media string `json:"media"`
714 Caption string `json:"caption"`
715 ParseMode string `json:"parse_mode"`
716}
717
718// InputMediaVideo contains a video for displaying as part of a media group.
719type InputMediaVideo struct {
720 Type string `json:"type"`
721 Media string `json:"media"`
722 // thumb intentionally missing as it is not currently compatible
723 Caption string `json:"caption"`
724 ParseMode string `json:"parse_mode"`
725 Width int `json:"width"`
726 Height int `json:"height"`
727 Duration int `json:"duration"`
728 SupportsStreaming bool `json:"supports_streaming"`
729}
730
731// InlineQuery is a Query from Telegram for an inline request.
732type InlineQuery struct {
733 ID string `json:"id"`
734 From *User `json:"from"`
735 Location *Location `json:"location"` // optional
736 Query string `json:"query"`
737 Offset string `json:"offset"`
738}
739
740// InlineQueryResultArticle is an inline query response article.
741type InlineQueryResultArticle struct {
742 Type string `json:"type"` // required
743 ID string `json:"id"` // required
744 Title string `json:"title"` // required
745 InputMessageContent interface{} `json:"input_message_content,omitempty"` // required
746 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
747 URL string `json:"url"`
748 HideURL bool `json:"hide_url"`
749 Description string `json:"description"`
750 ThumbURL string `json:"thumb_url"`
751 ThumbWidth int `json:"thumb_width"`
752 ThumbHeight int `json:"thumb_height"`
753}
754
755// InlineQueryResultPhoto is an inline query response photo.
756type InlineQueryResultPhoto struct {
757 Type string `json:"type"` // required
758 ID string `json:"id"` // required
759 URL string `json:"photo_url"` // required
760 MimeType string `json:"mime_type"`
761 Width int `json:"photo_width"`
762 Height int `json:"photo_height"`
763 ThumbURL string `json:"thumb_url"`
764 Title string `json:"title"`
765 Description string `json:"description"`
766 Caption string `json:"caption"`
767 ParseMode string `json:"parse_mode"`
768 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
769 InputMessageContent interface{} `json:"input_message_content,omitempty"`
770}
771
772// InlineQueryResultCachedPhoto is an inline query response with cached photo.
773type InlineQueryResultCachedPhoto struct {
774 Type string `json:"type"` // required
775 ID string `json:"id"` // required
776 PhotoID string `json:"photo_file_id"` // required
777 Title string `json:"title"`
778 Description string `json:"description"`
779 Caption string `json:"caption"`
780 ParseMode string `json:"parse_mode"`
781 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
782 InputMessageContent interface{} `json:"input_message_content,omitempty"`
783}
784
785// InlineQueryResultGIF is an inline query response GIF.
786type InlineQueryResultGIF struct {
787 Type string `json:"type"` // required
788 ID string `json:"id"` // required
789 URL string `json:"gif_url"` // required
790 ThumbURL string `json:"thumb_url"` // required
791 Width int `json:"gif_width,omitempty"`
792 Height int `json:"gif_height,omitempty"`
793 Duration int `json:"gif_duration,omitempty"`
794 Title string `json:"title,omitempty"`
795 Caption string `json:"caption,omitempty"`
796 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
797 InputMessageContent interface{} `json:"input_message_content,omitempty"`
798}
799
800// InlineQueryResultCachedGIF is an inline query response with cached gif.
801type InlineQueryResultCachedGIF struct {
802 Type string `json:"type"` // required
803 ID string `json:"id"` // required
804 GifID string `json:"gif_file_id"` // required
805 Title string `json:"title"`
806 Caption string `json:"caption"`
807 ParseMode string `json:"parse_mode"`
808 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
809 InputMessageContent interface{} `json:"input_message_content,omitempty"`
810}
811
812// InlineQueryResultMPEG4GIF is an inline query response MPEG4 GIF.
813type InlineQueryResultMPEG4GIF struct {
814 Type string `json:"type"` // required
815 ID string `json:"id"` // required
816 URL string `json:"mpeg4_url"` // required
817 Width int `json:"mpeg4_width"`
818 Height int `json:"mpeg4_height"`
819 Duration int `json:"mpeg4_duration"`
820 ThumbURL string `json:"thumb_url"`
821 Title string `json:"title"`
822 Caption string `json:"caption"`
823 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
824 InputMessageContent interface{} `json:"input_message_content,omitempty"`
825}
826
827// InlineQueryResultCachedMpeg4Gif is an inline query response with cached
828// H.264/MPEG-4 AVC video without sound gif.
829type InlineQueryResultCachedMpeg4Gif struct {
830 Type string `json:"type"` // required
831 ID string `json:"id"` // required
832 MGifID string `json:"mpeg4_file_id"` // required
833 Title string `json:"title"`
834 Caption string `json:"caption"`
835 ParseMode string `json:"parse_mode"`
836 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
837 InputMessageContent interface{} `json:"input_message_content,omitempty"`
838}
839
840// InlineQueryResultVideo is an inline query response video.
841type InlineQueryResultVideo struct {
842 Type string `json:"type"` // required
843 ID string `json:"id"` // required
844 URL string `json:"video_url"` // required
845 MimeType string `json:"mime_type"` // required
846 ThumbURL string `json:"thumb_url"`
847 Title string `json:"title"`
848 Caption string `json:"caption"`
849 Width int `json:"video_width"`
850 Height int `json:"video_height"`
851 Duration int `json:"video_duration"`
852 Description string `json:"description"`
853 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
854 InputMessageContent interface{} `json:"input_message_content,omitempty"`
855}
856
857// InlineQueryResultCachedVideo is an inline query response with cached video.
858type InlineQueryResultCachedVideo struct {
859 Type string `json:"type"` // required
860 ID string `json:"id"` // required
861 VideoID string `json:"video_file_id"` // required
862 Title string `json:"title"` // required
863 Description string `json:"description"`
864 Caption string `json:"caption"`
865 ParseMode string `json:"parse_mode"`
866 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
867 InputMessageContent interface{} `json:"input_message_content,omitempty"`
868}
869
870// InlineQueryResultCachedSticker is an inline query response with cached sticker.
871type InlineQueryResultCachedSticker struct {
872 Type string `json:"type"` // required
873 ID string `json:"id"` // required
874 StickerID string `json:"sticker_file_id"` // required
875 Title string `json:"title"` // required
876 ParseMode string `json:"parse_mode"`
877 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
878 InputMessageContent interface{} `json:"input_message_content,omitempty"`
879}
880
881// InlineQueryResultAudio is an inline query response audio.
882type InlineQueryResultAudio struct {
883 Type string `json:"type"` // required
884 ID string `json:"id"` // required
885 URL string `json:"audio_url"` // required
886 Title string `json:"title"` // required
887 Caption string `json:"caption"`
888 Performer string `json:"performer"`
889 Duration int `json:"audio_duration"`
890 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
891 InputMessageContent interface{} `json:"input_message_content,omitempty"`
892}
893
894// InlineQueryResultCachedAudio is an inline query response with cached audio.
895type InlineQueryResultCachedAudio struct {
896 Type string `json:"type"` // required
897 ID string `json:"id"` // required
898 AudioID string `json:"audio_file_id"` // required
899 Caption string `json:"caption"`
900 ParseMode string `json:"parse_mode"`
901 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
902 InputMessageContent interface{} `json:"input_message_content,omitempty"`
903}
904
905// InlineQueryResultVoice is an inline query response voice.
906type InlineQueryResultVoice struct {
907 Type string `json:"type"` // required
908 ID string `json:"id"` // required
909 URL string `json:"voice_url"` // required
910 Title string `json:"title"` // required
911 Caption string `json:"caption"`
912 Duration int `json:"voice_duration"`
913 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
914 InputMessageContent interface{} `json:"input_message_content,omitempty"`
915}
916
917// InlineQueryResultCachedVoice is an inline query response with cached voice.
918type InlineQueryResultCachedVoice struct {
919 Type string `json:"type"` // required
920 ID string `json:"id"` // required
921 VoiceID string `json:"voice_file_id"` // required
922 Title string `json:"title"` // required
923 Caption string `json:"caption"`
924 ParseMode string `json:"parse_mode"`
925 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
926 InputMessageContent interface{} `json:"input_message_content,omitempty"`
927}
928
929// InlineQueryResultDocument is an inline query response document.
930type InlineQueryResultDocument struct {
931 Type string `json:"type"` // required
932 ID string `json:"id"` // required
933 Title string `json:"title"` // required
934 Caption string `json:"caption"`
935 URL string `json:"document_url"` // required
936 MimeType string `json:"mime_type"` // required
937 Description string `json:"description"`
938 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
939 InputMessageContent interface{} `json:"input_message_content,omitempty"`
940 ThumbURL string `json:"thumb_url"`
941 ThumbWidth int `json:"thumb_width"`
942 ThumbHeight int `json:"thumb_height"`
943}
944
945// InlineQueryResultCachedDocument is an inline query response with cached document.
946type InlineQueryResultCachedDocument struct {
947 Type string `json:"type"` // required
948 ID string `json:"id"` // required
949 DocumentID string `json:"document_file_id"` // required
950 Title string `json:"title"` // required
951 Caption string `json:"caption"`
952 Description string `json:"description"`
953 ParseMode string `json:"parse_mode"`
954 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
955 InputMessageContent interface{} `json:"input_message_content,omitempty"`
956}
957
958// InlineQueryResultLocation is an inline query response location.
959type InlineQueryResultLocation struct {
960 Type string `json:"type"` // required
961 ID string `json:"id"` // required
962 Latitude float64 `json:"latitude"` // required
963 Longitude float64 `json:"longitude"` // required
964 Title string `json:"title"` // required
965 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
966 InputMessageContent interface{} `json:"input_message_content,omitempty"`
967 ThumbURL string `json:"thumb_url"`
968 ThumbWidth int `json:"thumb_width"`
969 ThumbHeight int `json:"thumb_height"`
970}
971
972// InlineQueryResultVenue is an inline query response venue.
973type InlineQueryResultVenue struct {
974 Type string `json:"type"` // required
975 ID string `json:"id"` // required
976 Latitude float64 `json:"latitude"` // required
977 Longitude float64 `json:"longitude"` // required
978 Title string `json:"title"` // required
979 Address string `json:"address"` // required
980 FoursquareID string `json:"foursquare_id"`
981 FoursquareType string `json:"foursquare_type"`
982 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
983 InputMessageContent interface{} `json:"input_message_content,omitempty"`
984 ThumbURL string `json:"thumb_url"`
985 ThumbWidth int `json:"thumb_width"`
986 ThumbHeight int `json:"thumb_height"`
987}
988
989// InlineQueryResultGame is an inline query response game.
990type InlineQueryResultGame struct {
991 Type string `json:"type"`
992 ID string `json:"id"`
993 GameShortName string `json:"game_short_name"`
994 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
995}
996
997// ChosenInlineResult is an inline query result chosen by a User
998type ChosenInlineResult struct {
999 ResultID string `json:"result_id"`
1000 From *User `json:"from"`
1001 Location *Location `json:"location"`
1002 InlineMessageID string `json:"inline_message_id"`
1003 Query string `json:"query"`
1004}
1005
1006// InputTextMessageContent contains text for displaying
1007// as an inline query result.
1008type InputTextMessageContent struct {
1009 Text string `json:"message_text"`
1010 ParseMode string `json:"parse_mode"`
1011 DisableWebPagePreview bool `json:"disable_web_page_preview"`
1012}
1013
1014// InputLocationMessageContent contains a location for displaying
1015// as an inline query result.
1016type InputLocationMessageContent struct {
1017 Latitude float64 `json:"latitude"`
1018 Longitude float64 `json:"longitude"`
1019}
1020
1021// InputVenueMessageContent contains a venue for displaying
1022// as an inline query result.
1023type InputVenueMessageContent struct {
1024 Latitude float64 `json:"latitude"`
1025 Longitude float64 `json:"longitude"`
1026 Title string `json:"title"`
1027 Address string `json:"address"`
1028 FoursquareID string `json:"foursquare_id"`
1029}
1030
1031// InputContactMessageContent contains a contact for displaying
1032// as an inline query result.
1033type InputContactMessageContent struct {
1034 PhoneNumber string `json:"phone_number"`
1035 FirstName string `json:"first_name"`
1036 LastName string `json:"last_name"`
1037}
1038
1039// Invoice contains basic information about an invoice.
1040type Invoice struct {
1041 Title string `json:"title"`
1042 Description string `json:"description"`
1043 StartParameter string `json:"start_parameter"`
1044 Currency string `json:"currency"`
1045 TotalAmount int `json:"total_amount"`
1046}
1047
1048// LabeledPrice represents a portion of the price for goods or services.
1049type LabeledPrice struct {
1050 Label string `json:"label"`
1051 Amount int `json:"amount"`
1052}
1053
1054// ShippingAddress represents a shipping address.
1055type ShippingAddress struct {
1056 CountryCode string `json:"country_code"`
1057 State string `json:"state"`
1058 City string `json:"city"`
1059 StreetLine1 string `json:"street_line1"`
1060 StreetLine2 string `json:"street_line2"`
1061 PostCode string `json:"post_code"`
1062}
1063
1064// OrderInfo represents information about an order.
1065type OrderInfo struct {
1066 Name string `json:"name,omitempty"`
1067 PhoneNumber string `json:"phone_number,omitempty"`
1068 Email string `json:"email,omitempty"`
1069 ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"`
1070}
1071
1072// ShippingOption represents one shipping option.
1073type ShippingOption struct {
1074 ID string `json:"id"`
1075 Title string `json:"title"`
1076 Prices *[]LabeledPrice `json:"prices"`
1077}
1078
1079// SuccessfulPayment contains basic information about a successful payment.
1080type SuccessfulPayment struct {
1081 Currency string `json:"currency"`
1082 TotalAmount int `json:"total_amount"`
1083 InvoicePayload string `json:"invoice_payload"`
1084 ShippingOptionID string `json:"shipping_option_id,omitempty"`
1085 OrderInfo *OrderInfo `json:"order_info,omitempty"`
1086 TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
1087 ProviderPaymentChargeID string `json:"provider_payment_charge_id"`
1088}
1089
1090// ShippingQuery contains information about an incoming shipping query.
1091type ShippingQuery struct {
1092 ID string `json:"id"`
1093 From *User `json:"from"`
1094 InvoicePayload string `json:"invoice_payload"`
1095 ShippingAddress *ShippingAddress `json:"shipping_address"`
1096}
1097
1098// PreCheckoutQuery contains information about an incoming pre-checkout query.
1099type PreCheckoutQuery struct {
1100 ID string `json:"id"`
1101 From *User `json:"from"`
1102 Currency string `json:"currency"`
1103 TotalAmount int `json:"total_amount"`
1104 InvoicePayload string `json:"invoice_payload"`
1105 ShippingOptionID string `json:"shipping_option_id,omitempty"`
1106 OrderInfo *OrderInfo `json:"order_info,omitempty"`
1107}
1108
1109// Error is an error containing extra information returned by the Telegram API.
1110type Error struct {
1111 Code int
1112 Message string
1113 ResponseParameters
1114}
1115
1116func (e Error) Error() string {
1117 return e.Message
1118}
1119
1120// BotCommand represents a bot command.
1121type BotCommand struct {
1122 Command string `json:"command"`
1123 Description string `json:"description"`
1124}