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 identifier for this file, which can be used to download or reuse the file
432 FileID string `json:"file_id"`
433 // Width photo width
434 Width int `json:"width"`
435 // Height photo height
436 Height int `json:"height"`
437 // FileSize file size
438 // optional
439 FileSize int `json:"file_size"`
440}
441
442// Audio contains information about audio.
443type Audio struct {
444 // FileID is an identifier for this file, which can be used to download or reuse the file
445 FileID string `json:"file_id"`
446 // Duration of the audio in seconds as defined by sender
447 Duration int `json:"duration"`
448 // Performer of the audio as defined by sender or by audio tags
449 // optional
450 Performer string `json:"performer"`
451 // Title of the audio as defined by sender or by audio tags
452 // optional
453 Title string `json:"title"`
454 // MimeType of the file as defined by sender
455 // optional
456 MimeType string `json:"mime_type"`
457 // FileSize file size
458 // optional
459 FileSize int `json:"file_size"`
460}
461
462// Document contains information about a document.
463type Document struct {
464 // FileID is a identifier for this file, which can be used to download or reuse the file
465 FileID string `json:"file_id"`
466 // Thumbnail document thumbnail as defined by sender
467 // optional
468 Thumbnail *PhotoSize `json:"thumb"`
469 // FileName original filename as defined by sender
470 // optional
471 FileName string `json:"file_name"`
472 // MimeType of the file as defined by sender
473 // optional
474 MimeType string `json:"mime_type"`
475 // FileSize file size
476 // optional
477 FileSize int `json:"file_size"`
478}
479
480// Sticker contains information about a sticker.
481type Sticker struct {
482 // FileUniqueID is an unique identifier for this file,
483 // which is supposed to be the same over time and for different bots.
484 // Can't be used to download or reuse the file.
485 FileUniqueID string `json:"file_unique_id"`
486 // FileID is an identifier for this file, which can be used to download or reuse the file
487 FileID string `json:"file_id"`
488 // Width sticker width
489 Width int `json:"width"`
490 // Height sticker height
491 Height int `json:"height"`
492 // Thumbnail sticker thumbnail in the .WEBP or .JPG format
493 // optional
494 Thumbnail *PhotoSize `json:"thumb"`
495 // Emoji associated with the sticker
496 // optional
497 Emoji string `json:"emoji"`
498 // FileSize
499 // optional
500 FileSize int `json:"file_size"`
501 // SetName of the sticker set to which the sticker belongs
502 // optional
503 SetName string `json:"set_name"`
504 // IsAnimated true, if the sticker is animated
505 // optional
506 IsAnimated bool `json:"is_animated"`
507}
508
509// StickerSet contains information about an sticker set.
510type StickerSet struct {
511 // Name sticker set name
512 Name string `json:"name"`
513 // Title sticker set title
514 Title string `json:"title"`
515 // IsAnimated true, if the sticker set contains animated stickers
516 IsAnimated bool `json:"is_animated"`
517 // ContainsMasks true, if the sticker set contains masks
518 ContainsMasks bool `json:"contains_masks"`
519 // Stickers list of all set stickers
520 Stickers []Sticker `json:"stickers"`
521}
522
523// ChatAnimation contains information about an animation.
524type ChatAnimation struct {
525 // FileID odentifier for this file, which can be used to download or reuse the file
526 FileID string `json:"file_id"`
527 // Width video width as defined by sender
528 Width int `json:"width"`
529 // Height video height as defined by sender
530 Height int `json:"height"`
531 // Duration of the video in seconds as defined by sender
532 Duration int `json:"duration"`
533 // Thumbnail animation thumbnail as defined by sender
534 // optional
535 Thumbnail *PhotoSize `json:"thumb"`
536 // FileName original animation filename as defined by sender
537 // optional
538 FileName string `json:"file_name"`
539 // MimeType of the file as defined by sender
540 // optional
541 MimeType string `json:"mime_type"`
542 // FileSize file size
543 // optional
544 FileSize int `json:"file_size"`
545}
546
547// Video contains information about a video.
548type Video struct {
549 // FileID identifier for this file, which can be used to download or reuse the file
550 FileID string `json:"file_id"`
551 // Width video width as defined by sender
552 Width int `json:"width"`
553 // Height video height as defined by sender
554 Height int `json:"height"`
555 // Duration of the video in seconds as defined by sender
556 Duration int `json:"duration"`
557 // Thumbnail video thumbnail
558 // optional
559 Thumbnail *PhotoSize `json:"thumb"`
560 // MimeType of a file as defined by sender
561 // optional
562 MimeType string `json:"mime_type"`
563 // FileSize file size
564 // optional
565 FileSize int `json:"file_size"`
566}
567
568// VideoNote contains information about a video.
569type VideoNote struct {
570 // FileID identifier for this file, which can be used to download or reuse the file
571 FileID string `json:"file_id"`
572 // Length video width and height (diameter of the video message) as defined by sender
573 Length int `json:"length"`
574 // Duration of the video in seconds as defined by sender
575 Duration int `json:"duration"`
576 // Thumbnail video thumbnail
577 // optional
578 Thumbnail *PhotoSize `json:"thumb"`
579 // FileSize file size
580 // optional
581 FileSize int `json:"file_size"`
582}
583
584// Voice contains information about a voice.
585type Voice struct {
586 // FileID identifier for this file, which can be used to download or reuse the file
587 FileID string `json:"file_id"`
588 // Duration of the audio in seconds as defined by sender
589 Duration int `json:"duration"`
590 // MimeType of the file as defined by sender
591 // optional
592 MimeType string `json:"mime_type"`
593 // FileSize file size
594 // optional
595 FileSize int `json:"file_size"`
596}
597
598// Contact contains information about a contact.
599//
600// Note that LastName and UserID may be empty.
601type Contact struct {
602 // PhoneNumber contact's phone number
603 PhoneNumber string `json:"phone_number"`
604 // FirstName contact's first name
605 FirstName string `json:"first_name"`
606 // LastName contact's last name
607 // optional
608 LastName string `json:"last_name"`
609 // UserID contact's user identifier in Telegram
610 // optional
611 UserID int `json:"user_id"`
612}
613
614// Location contains information about a place.
615type Location struct {
616 // Longitude as defined by sender
617 Longitude float64 `json:"longitude"`
618 // Latitude as defined by sender
619 Latitude float64 `json:"latitude"`
620}
621
622// Venue contains information about a venue, including its Location.
623type Venue struct {
624 // Location venue location
625 Location Location `json:"location"`
626 // Title name of the venue
627 Title string `json:"title"`
628 // Address of the venue
629 Address string `json:"address"`
630 // FoursquareID foursquare identifier of the venue
631 // optional
632 FoursquareID string `json:"foursquare_id"`
633}
634
635// UserProfilePhotos contains a set of user profile photos.
636type UserProfilePhotos struct {
637 // TotalCount total number of profile pictures the target user has
638 TotalCount int `json:"total_count"`
639 // Photos requested profile pictures (in up to 4 sizes each)
640 Photos [][]PhotoSize `json:"photos"`
641}
642
643// File contains information about a file to download from Telegram.
644type File struct {
645 FileID string `json:"file_id"`
646 FileSize int `json:"file_size"` // optional
647 FilePath string `json:"file_path"` // optional
648}
649
650// Link returns a full path to the download URL for a File.
651//
652// It requires the Bot Token to create the link.
653func (f *File) Link(token string) string {
654 return fmt.Sprintf(FileEndpoint, token, f.FilePath)
655}
656
657// ReplyKeyboardMarkup allows the Bot to set a custom keyboard.
658type ReplyKeyboardMarkup struct {
659 Keyboard [][]KeyboardButton `json:"keyboard"`
660 ResizeKeyboard bool `json:"resize_keyboard"` // optional
661 OneTimeKeyboard bool `json:"one_time_keyboard"` // optional
662 Selective bool `json:"selective"` // optional
663}
664
665// KeyboardButton is a button within a custom keyboard.
666type KeyboardButton struct {
667 Text string `json:"text"`
668 RequestContact bool `json:"request_contact"`
669 RequestLocation bool `json:"request_location"`
670}
671
672// ReplyKeyboardHide allows the Bot to hide a custom keyboard.
673type ReplyKeyboardHide struct {
674 HideKeyboard bool `json:"hide_keyboard"`
675 Selective bool `json:"selective"` // optional
676}
677
678// ReplyKeyboardRemove allows the Bot to hide a custom keyboard.
679type ReplyKeyboardRemove struct {
680 RemoveKeyboard bool `json:"remove_keyboard"`
681 Selective bool `json:"selective"`
682}
683
684// InlineKeyboardMarkup is a custom keyboard presented for an inline bot.
685type InlineKeyboardMarkup struct {
686 InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
687}
688
689// InlineKeyboardButton is a button within a custom keyboard for
690// inline query responses.
691//
692// Note that some values are references as even an empty string
693// will change behavior.
694//
695// CallbackGame, if set, MUST be first button in first row.
696type InlineKeyboardButton struct {
697 Text string `json:"text"`
698 URL *string `json:"url,omitempty"` // optional
699 CallbackData *string `json:"callback_data,omitempty"` // optional
700 SwitchInlineQuery *string `json:"switch_inline_query,omitempty"` // optional
701 SwitchInlineQueryCurrentChat *string `json:"switch_inline_query_current_chat,omitempty"` // optional
702 CallbackGame *CallbackGame `json:"callback_game,omitempty"` // optional
703 Pay bool `json:"pay,omitempty"` // optional
704}
705
706// CallbackQuery is data sent when a keyboard button with callback data
707// is clicked.
708type CallbackQuery struct {
709 ID string `json:"id"`
710 From *User `json:"from"`
711 Message *Message `json:"message"` // optional
712 InlineMessageID string `json:"inline_message_id"` // optional
713 ChatInstance string `json:"chat_instance"`
714 Data string `json:"data"` // optional
715 GameShortName string `json:"game_short_name"` // optional
716}
717
718// ForceReply allows the Bot to have users directly reply to it without
719// additional interaction.
720type ForceReply struct {
721 ForceReply bool `json:"force_reply"`
722 Selective bool `json:"selective"` // optional
723}
724
725// ChatMember is information about a member in a chat.
726type ChatMember struct {
727 User *User `json:"user"`
728 Status string `json:"status"`
729 CustomTitle string `json:"custom_title,omitempty"` // optional
730 UntilDate int64 `json:"until_date,omitempty"` // optional
731 CanBeEdited bool `json:"can_be_edited,omitempty"` // optional
732 CanChangeInfo bool `json:"can_change_info,omitempty"` // optional
733 CanPostMessages bool `json:"can_post_messages,omitempty"` // optional
734 CanEditMessages bool `json:"can_edit_messages,omitempty"` // optional
735 CanDeleteMessages bool `json:"can_delete_messages,omitempty"` // optional
736 CanInviteUsers bool `json:"can_invite_users,omitempty"` // optional
737 CanRestrictMembers bool `json:"can_restrict_members,omitempty"` // optional
738 CanPinMessages bool `json:"can_pin_messages,omitempty"` // optional
739 CanPromoteMembers bool `json:"can_promote_members,omitempty"` // optional
740 CanSendMessages bool `json:"can_send_messages,omitempty"` // optional
741 CanSendMediaMessages bool `json:"can_send_media_messages,omitempty"` // optional
742 CanSendOtherMessages bool `json:"can_send_other_messages,omitempty"` // optional
743 CanAddWebPagePreviews bool `json:"can_add_web_page_previews,omitempty"` // optional
744}
745
746// IsCreator returns if the ChatMember was the creator of the chat.
747func (chat ChatMember) IsCreator() bool { return chat.Status == "creator" }
748
749// IsAdministrator returns if the ChatMember is a chat administrator.
750func (chat ChatMember) IsAdministrator() bool { return chat.Status == "administrator" }
751
752// IsMember returns if the ChatMember is a current member of the chat.
753func (chat ChatMember) IsMember() bool { return chat.Status == "member" }
754
755// HasLeft returns if the ChatMember left the chat.
756func (chat ChatMember) HasLeft() bool { return chat.Status == "left" }
757
758// WasKicked returns if the ChatMember was kicked from the chat.
759func (chat ChatMember) WasKicked() bool { return chat.Status == "kicked" }
760
761// Game is a game within Telegram.
762type Game struct {
763 Title string `json:"title"`
764 Description string `json:"description"`
765 Photo []PhotoSize `json:"photo"`
766 Text string `json:"text"`
767 TextEntities []MessageEntity `json:"text_entities"`
768 Animation Animation `json:"animation"`
769}
770
771// Animation is a GIF animation demonstrating the game.
772type Animation struct {
773 FileID string `json:"file_id"`
774 Thumb PhotoSize `json:"thumb"`
775 FileName string `json:"file_name"`
776 MimeType string `json:"mime_type"`
777 FileSize int `json:"file_size"`
778}
779
780// GameHighScore is a user's score and position on the leaderboard.
781type GameHighScore struct {
782 Position int `json:"position"`
783 User User `json:"user"`
784 Score int `json:"score"`
785}
786
787// CallbackGame is for starting a game in an inline keyboard button.
788type CallbackGame struct{}
789
790// WebhookInfo is information about a currently set webhook.
791type WebhookInfo struct {
792 URL string `json:"url"`
793 HasCustomCertificate bool `json:"has_custom_certificate"`
794 PendingUpdateCount int `json:"pending_update_count"`
795 LastErrorDate int `json:"last_error_date"` // optional
796 LastErrorMessage string `json:"last_error_message"` // optional
797 MaxConnections int `json:"max_connections"` // optional
798}
799
800// IsSet returns true if a webhook is currently set.
801func (info WebhookInfo) IsSet() bool {
802 return info.URL != ""
803}
804
805// InputMediaPhoto contains a photo for displaying as part of a media group.
806type InputMediaPhoto struct {
807 Type string `json:"type"`
808 Media string `json:"media"`
809 Caption string `json:"caption"`
810 ParseMode string `json:"parse_mode"`
811}
812
813// InputMediaVideo contains a video for displaying as part of a media group.
814type InputMediaVideo struct {
815 Type string `json:"type"`
816 Media string `json:"media"`
817 // thumb intentionally missing as it is not currently compatible
818 Caption string `json:"caption"`
819 ParseMode string `json:"parse_mode"`
820 Width int `json:"width"`
821 Height int `json:"height"`
822 Duration int `json:"duration"`
823 SupportsStreaming bool `json:"supports_streaming"`
824}
825
826// InlineQuery is a Query from Telegram for an inline request.
827type InlineQuery struct {
828 ID string `json:"id"`
829 From *User `json:"from"`
830 Location *Location `json:"location"` // optional
831 Query string `json:"query"`
832 Offset string `json:"offset"`
833}
834
835// InlineQueryResultArticle is an inline query response article.
836type InlineQueryResultArticle struct {
837 Type string `json:"type"` // required
838 ID string `json:"id"` // required
839 Title string `json:"title"` // required
840 InputMessageContent interface{} `json:"input_message_content,omitempty"` // required
841 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
842 URL string `json:"url"`
843 HideURL bool `json:"hide_url"`
844 Description string `json:"description"`
845 ThumbURL string `json:"thumb_url"`
846 ThumbWidth int `json:"thumb_width"`
847 ThumbHeight int `json:"thumb_height"`
848}
849
850// InlineQueryResultPhoto is an inline query response photo.
851type InlineQueryResultPhoto struct {
852 Type string `json:"type"` // required
853 ID string `json:"id"` // required
854 URL string `json:"photo_url"` // required
855 MimeType string `json:"mime_type"`
856 Width int `json:"photo_width"`
857 Height int `json:"photo_height"`
858 ThumbURL string `json:"thumb_url"`
859 Title string `json:"title"`
860 Description string `json:"description"`
861 Caption string `json:"caption"`
862 ParseMode string `json:"parse_mode"`
863 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
864 InputMessageContent interface{} `json:"input_message_content,omitempty"`
865}
866
867// InlineQueryResultCachedPhoto is an inline query response with cached photo.
868type InlineQueryResultCachedPhoto struct {
869 Type string `json:"type"` // required
870 ID string `json:"id"` // required
871 PhotoID string `json:"photo_file_id"` // required
872 Title string `json:"title"`
873 Description string `json:"description"`
874 Caption string `json:"caption"`
875 ParseMode string `json:"parse_mode"`
876 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
877 InputMessageContent interface{} `json:"input_message_content,omitempty"`
878}
879
880// InlineQueryResultGIF is an inline query response GIF.
881type InlineQueryResultGIF struct {
882 Type string `json:"type"` // required
883 ID string `json:"id"` // required
884 URL string `json:"gif_url"` // required
885 ThumbURL string `json:"thumb_url"` // required
886 Width int `json:"gif_width,omitempty"`
887 Height int `json:"gif_height,omitempty"`
888 Duration int `json:"gif_duration,omitempty"`
889 Title string `json:"title,omitempty"`
890 Caption string `json:"caption,omitempty"`
891 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
892 InputMessageContent interface{} `json:"input_message_content,omitempty"`
893}
894
895// InlineQueryResultCachedGIF is an inline query response with cached gif.
896type InlineQueryResultCachedGIF struct {
897 Type string `json:"type"` // required
898 ID string `json:"id"` // required
899 GifID string `json:"gif_file_id"` // required
900 Title string `json:"title"`
901 Caption string `json:"caption"`
902 ParseMode string `json:"parse_mode"`
903 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
904 InputMessageContent interface{} `json:"input_message_content,omitempty"`
905}
906
907// InlineQueryResultMPEG4GIF is an inline query response MPEG4 GIF.
908type InlineQueryResultMPEG4GIF struct {
909 Type string `json:"type"` // required
910 ID string `json:"id"` // required
911 URL string `json:"mpeg4_url"` // required
912 Width int `json:"mpeg4_width"`
913 Height int `json:"mpeg4_height"`
914 Duration int `json:"mpeg4_duration"`
915 ThumbURL string `json:"thumb_url"`
916 Title string `json:"title"`
917 Caption string `json:"caption"`
918 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
919 InputMessageContent interface{} `json:"input_message_content,omitempty"`
920}
921
922// InlineQueryResultCachedMpeg4Gif is an inline query response with cached
923// H.264/MPEG-4 AVC video without sound gif.
924type InlineQueryResultCachedMpeg4Gif struct {
925 Type string `json:"type"` // required
926 ID string `json:"id"` // required
927 MGifID string `json:"mpeg4_file_id"` // required
928 Title string `json:"title"`
929 Caption string `json:"caption"`
930 ParseMode string `json:"parse_mode"`
931 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
932 InputMessageContent interface{} `json:"input_message_content,omitempty"`
933}
934
935// InlineQueryResultVideo is an inline query response video.
936type InlineQueryResultVideo struct {
937 Type string `json:"type"` // required
938 ID string `json:"id"` // required
939 URL string `json:"video_url"` // required
940 MimeType string `json:"mime_type"` // required
941 ThumbURL string `json:"thumb_url"`
942 Title string `json:"title"`
943 Caption string `json:"caption"`
944 Width int `json:"video_width"`
945 Height int `json:"video_height"`
946 Duration int `json:"video_duration"`
947 Description string `json:"description"`
948 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
949 InputMessageContent interface{} `json:"input_message_content,omitempty"`
950}
951
952// InlineQueryResultCachedVideo is an inline query response with cached video.
953type InlineQueryResultCachedVideo struct {
954 Type string `json:"type"` // required
955 ID string `json:"id"` // required
956 VideoID string `json:"video_file_id"` // required
957 Title string `json:"title"` // required
958 Description string `json:"description"`
959 Caption string `json:"caption"`
960 ParseMode string `json:"parse_mode"`
961 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
962 InputMessageContent interface{} `json:"input_message_content,omitempty"`
963}
964
965// InlineQueryResultCachedSticker is an inline query response with cached sticker.
966type InlineQueryResultCachedSticker struct {
967 Type string `json:"type"` // required
968 ID string `json:"id"` // required
969 StickerID string `json:"sticker_file_id"` // required
970 Title string `json:"title"` // required
971 ParseMode string `json:"parse_mode"`
972 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
973 InputMessageContent interface{} `json:"input_message_content,omitempty"`
974}
975
976// InlineQueryResultAudio is an inline query response audio.
977type InlineQueryResultAudio struct {
978 Type string `json:"type"` // required
979 ID string `json:"id"` // required
980 URL string `json:"audio_url"` // required
981 Title string `json:"title"` // required
982 Caption string `json:"caption"`
983 Performer string `json:"performer"`
984 Duration int `json:"audio_duration"`
985 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
986 InputMessageContent interface{} `json:"input_message_content,omitempty"`
987}
988
989// InlineQueryResultCachedAudio is an inline query response with cached audio.
990type InlineQueryResultCachedAudio struct {
991 Type string `json:"type"` // required
992 ID string `json:"id"` // required
993 AudioID string `json:"audio_file_id"` // required
994 Caption string `json:"caption"`
995 ParseMode string `json:"parse_mode"`
996 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
997 InputMessageContent interface{} `json:"input_message_content,omitempty"`
998}
999
1000// InlineQueryResultVoice is an inline query response voice.
1001type InlineQueryResultVoice struct {
1002 Type string `json:"type"` // required
1003 ID string `json:"id"` // required
1004 URL string `json:"voice_url"` // required
1005 Title string `json:"title"` // required
1006 Caption string `json:"caption"`
1007 Duration int `json:"voice_duration"`
1008 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1009 InputMessageContent interface{} `json:"input_message_content,omitempty"`
1010}
1011
1012// InlineQueryResultCachedVoice is an inline query response with cached voice.
1013type InlineQueryResultCachedVoice struct {
1014 Type string `json:"type"` // required
1015 ID string `json:"id"` // required
1016 VoiceID string `json:"voice_file_id"` // required
1017 Title string `json:"title"` // required
1018 Caption string `json:"caption"`
1019 ParseMode string `json:"parse_mode"`
1020 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1021 InputMessageContent interface{} `json:"input_message_content,omitempty"`
1022}
1023
1024// InlineQueryResultDocument is an inline query response document.
1025type InlineQueryResultDocument struct {
1026 Type string `json:"type"` // required
1027 ID string `json:"id"` // required
1028 Title string `json:"title"` // required
1029 Caption string `json:"caption"`
1030 URL string `json:"document_url"` // required
1031 MimeType string `json:"mime_type"` // required
1032 Description string `json:"description"`
1033 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1034 InputMessageContent interface{} `json:"input_message_content,omitempty"`
1035 ThumbURL string `json:"thumb_url"`
1036 ThumbWidth int `json:"thumb_width"`
1037 ThumbHeight int `json:"thumb_height"`
1038}
1039
1040// InlineQueryResultCachedDocument is an inline query response with cached document.
1041type InlineQueryResultCachedDocument struct {
1042 Type string `json:"type"` // required
1043 ID string `json:"id"` // required
1044 DocumentID string `json:"document_file_id"` // required
1045 Title string `json:"title"` // required
1046 Caption string `json:"caption"`
1047 Description string `json:"description"`
1048 ParseMode string `json:"parse_mode"`
1049 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1050 InputMessageContent interface{} `json:"input_message_content,omitempty"`
1051}
1052
1053// InlineQueryResultLocation is an inline query response location.
1054type InlineQueryResultLocation struct {
1055 Type string `json:"type"` // required
1056 ID string `json:"id"` // required
1057 Latitude float64 `json:"latitude"` // required
1058 Longitude float64 `json:"longitude"` // required
1059 Title string `json:"title"` // required
1060 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1061 InputMessageContent interface{} `json:"input_message_content,omitempty"`
1062 ThumbURL string `json:"thumb_url"`
1063 ThumbWidth int `json:"thumb_width"`
1064 ThumbHeight int `json:"thumb_height"`
1065}
1066
1067// InlineQueryResultVenue is an inline query response venue.
1068type InlineQueryResultVenue struct {
1069 Type string `json:"type"` // required
1070 ID string `json:"id"` // required
1071 Latitude float64 `json:"latitude"` // required
1072 Longitude float64 `json:"longitude"` // required
1073 Title string `json:"title"` // required
1074 Address string `json:"address"` // required
1075 FoursquareID string `json:"foursquare_id"`
1076 FoursquareType string `json:"foursquare_type"`
1077 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1078 InputMessageContent interface{} `json:"input_message_content,omitempty"`
1079 ThumbURL string `json:"thumb_url"`
1080 ThumbWidth int `json:"thumb_width"`
1081 ThumbHeight int `json:"thumb_height"`
1082}
1083
1084// InlineQueryResultGame is an inline query response game.
1085type InlineQueryResultGame struct {
1086 Type string `json:"type"`
1087 ID string `json:"id"`
1088 GameShortName string `json:"game_short_name"`
1089 ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
1090}
1091
1092// ChosenInlineResult is an inline query result chosen by a User
1093type ChosenInlineResult struct {
1094 ResultID string `json:"result_id"`
1095 From *User `json:"from"`
1096 Location *Location `json:"location"`
1097 InlineMessageID string `json:"inline_message_id"`
1098 Query string `json:"query"`
1099}
1100
1101// InputTextMessageContent contains text for displaying
1102// as an inline query result.
1103type InputTextMessageContent struct {
1104 Text string `json:"message_text"`
1105 ParseMode string `json:"parse_mode"`
1106 DisableWebPagePreview bool `json:"disable_web_page_preview"`
1107}
1108
1109// InputLocationMessageContent contains a location for displaying
1110// as an inline query result.
1111type InputLocationMessageContent struct {
1112 Latitude float64 `json:"latitude"`
1113 Longitude float64 `json:"longitude"`
1114}
1115
1116// InputVenueMessageContent contains a venue for displaying
1117// as an inline query result.
1118type InputVenueMessageContent struct {
1119 Latitude float64 `json:"latitude"`
1120 Longitude float64 `json:"longitude"`
1121 Title string `json:"title"`
1122 Address string `json:"address"`
1123 FoursquareID string `json:"foursquare_id"`
1124}
1125
1126// InputContactMessageContent contains a contact for displaying
1127// as an inline query result.
1128type InputContactMessageContent struct {
1129 PhoneNumber string `json:"phone_number"`
1130 FirstName string `json:"first_name"`
1131 LastName string `json:"last_name"`
1132}
1133
1134// Invoice contains basic information about an invoice.
1135type Invoice struct {
1136 Title string `json:"title"`
1137 Description string `json:"description"`
1138 StartParameter string `json:"start_parameter"`
1139 Currency string `json:"currency"`
1140 TotalAmount int `json:"total_amount"`
1141}
1142
1143// LabeledPrice represents a portion of the price for goods or services.
1144type LabeledPrice struct {
1145 Label string `json:"label"`
1146 Amount int `json:"amount"`
1147}
1148
1149// ShippingAddress represents a shipping address.
1150type ShippingAddress struct {
1151 CountryCode string `json:"country_code"`
1152 State string `json:"state"`
1153 City string `json:"city"`
1154 StreetLine1 string `json:"street_line1"`
1155 StreetLine2 string `json:"street_line2"`
1156 PostCode string `json:"post_code"`
1157}
1158
1159// OrderInfo represents information about an order.
1160type OrderInfo struct {
1161 Name string `json:"name,omitempty"`
1162 PhoneNumber string `json:"phone_number,omitempty"`
1163 Email string `json:"email,omitempty"`
1164 ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"`
1165}
1166
1167// ShippingOption represents one shipping option.
1168type ShippingOption struct {
1169 ID string `json:"id"`
1170 Title string `json:"title"`
1171 Prices *[]LabeledPrice `json:"prices"`
1172}
1173
1174// SuccessfulPayment contains basic information about a successful payment.
1175type SuccessfulPayment struct {
1176 Currency string `json:"currency"`
1177 TotalAmount int `json:"total_amount"`
1178 InvoicePayload string `json:"invoice_payload"`
1179 ShippingOptionID string `json:"shipping_option_id,omitempty"`
1180 OrderInfo *OrderInfo `json:"order_info,omitempty"`
1181 TelegramPaymentChargeID string `json:"telegram_payment_charge_id"`
1182 ProviderPaymentChargeID string `json:"provider_payment_charge_id"`
1183}
1184
1185// ShippingQuery contains information about an incoming shipping query.
1186type ShippingQuery struct {
1187 ID string `json:"id"`
1188 From *User `json:"from"`
1189 InvoicePayload string `json:"invoice_payload"`
1190 ShippingAddress *ShippingAddress `json:"shipping_address"`
1191}
1192
1193// PreCheckoutQuery contains information about an incoming pre-checkout query.
1194type PreCheckoutQuery struct {
1195 ID string `json:"id"`
1196 From *User `json:"from"`
1197 Currency string `json:"currency"`
1198 TotalAmount int `json:"total_amount"`
1199 InvoicePayload string `json:"invoice_payload"`
1200 ShippingOptionID string `json:"shipping_option_id,omitempty"`
1201 OrderInfo *OrderInfo `json:"order_info,omitempty"`
1202}
1203
1204// Error is an error containing extra information returned by the Telegram API.
1205type Error struct {
1206 Code int
1207 Message string
1208 ResponseParameters
1209}
1210
1211func (e Error) Error() string {
1212 return e.Message
1213}
1214
1215// BotCommand represents a bot command.
1216type BotCommand struct {
1217 Command string `json:"command"`
1218 Description string `json:"description"`
1219}