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