forked from mymmrac/telego
-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.go
4204 lines (3260 loc) · 176 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package tgo
import (
"errors"
"fmt"
"github.com/dsurl/tgo/api"
"github.com/goccy/go-json"
)
// Update - This object (https://core.telegram.org/bots/api#available-types) represents an incoming update.
// At most one of the optional parameters can be present in any given update.
type Update struct {
// UpdateID - The update's unique identifier. Update identifiers start from a certain positive number and
// increase sequentially. This ID becomes especially handy if you're using webhooks
// (https://core.telegram.org/bots/api#setwebhook), since it allows you to ignore repeated updates or to restore
// the correct update sequence, should they get out of order. If there are no new updates for at least a week,
// then identifier of the next update will be chosen randomly instead of sequentially.
UpdateID int `json:"update_id"`
// Message - Optional. New incoming message of any kind - text, photo, sticker, etc.
Message *Message `json:"message,omitempty"`
// EditedMessage - Optional. New version of a message that is known to the bot and was edited
EditedMessage *Message `json:"edited_message,omitempty"`
// ChannelPost - Optional. New incoming channel post of any kind - text, photo, sticker, etc.
ChannelPost *Message `json:"channel_post,omitempty"`
// EditedChannelPost - Optional. New version of a channel post that is known to the bot and was edited
EditedChannelPost *Message `json:"edited_channel_post,omitempty"`
// InlineQuery - Optional. New incoming inline (https://core.telegram.org/bots/api#inline-mode) query
InlineQuery *InlineQuery `json:"inline_query,omitempty"`
// ChosenInlineResult - Optional. The result of an inline (https://core.telegram.org/bots/api#inline-mode)
// query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback
// collecting (https://core.telegram.org/bots/inline#collecting-feedback) for details on how to enable these
// updates for your bot.
ChosenInlineResult *ChosenInlineResult `json:"chosen_inline_result,omitempty"`
// CallbackQuery - Optional. New incoming callback query
CallbackQuery *CallbackQuery `json:"callback_query,omitempty"`
// ShippingQuery - Optional. New incoming shipping query. Only for invoices with flexible price
ShippingQuery *ShippingQuery `json:"shipping_query,omitempty"`
// PreCheckoutQuery - Optional. New incoming pre-checkout query. Contains full information about checkout
PreCheckoutQuery *PreCheckoutQuery `json:"pre_checkout_query,omitempty"`
// Poll - Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent
// by the bot
Poll *Poll `json:"poll,omitempty"`
// PollAnswer - Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only
// in polls that were sent by the bot itself.
PollAnswer *PollAnswer `json:"poll_answer,omitempty"`
// MyChatMember - Optional. The bot's chat member status was updated in a chat. For private chats, this
// update is received only when the bot is blocked or unblocked by the user.
MyChatMember *ChatMemberUpdated `json:"my_chat_member,omitempty"`
// ChatMember - Optional. A chat member's status was updated in a chat. The bot must be an administrator in
// the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these
// updates.
ChatMember *ChatMemberUpdated `json:"chat_member,omitempty"`
// ChatJoinRequest - Optional. A request to join the chat has been sent. The bot must have the
// can_invite_users administrator right in the chat to receive these updates.
ChatJoinRequest *ChatJoinRequest `json:"chat_join_request,omitempty"`
}
// Clone returns deep copy of Update.
// Warning: Types like ChatMember and MenuButton requires to have their mandatory fields (like status or type) to be
// filled properly, else Clone() will panic. To safely clone, use CloneSafe().
func (u Update) Clone() Update {
update, err := u.CloneSafe()
if err != nil {
panic(err)
}
return update
}
// CloneSafe returns deep copy of Update or an error
func (u Update) CloneSafe() (Update, error) {
var update Update
data, err := json.Marshal(u)
if err != nil {
return Update{}, fmt.Errorf("tgo: clone update: marshal: %w", err)
}
err = json.Unmarshal(data, &update)
if err != nil {
return Update{}, fmt.Errorf("tgo: clone update: unmarshal: %w", err)
}
return update, nil
}
// WebhookInfo - Describes the current status of a webhook.
type WebhookInfo struct {
// URL - Webhook URL, may be empty if webhook is not set up
URL string `json:"url"`
// HasCustomCertificate - True, if a custom certificate was provided for webhook certificate checks
HasCustomCertificate bool `json:"has_custom_certificate"`
// PendingUpdateCount - Number of updates awaiting delivery
PendingUpdateCount int `json:"pending_update_count"`
// IPAddress - Optional. Currently used webhook IP address
IPAddress string `json:"ip_address,omitempty"`
// LastErrorDate - Optional. Unix time for the most recent error that happened when trying to deliver an
// update via webhook
LastErrorDate int64 `json:"last_error_date,omitempty"`
// LastErrorMessage - Optional. Error message in human-readable format for the most recent error that
// happened when trying to deliver an update via webhook
LastErrorMessage string `json:"last_error_message,omitempty"`
// LastSynchronizationErrorDate - Optional. Unix time of the most recent error that happened when trying to
// synchronize available updates with Telegram datacenters
LastSynchronizationErrorDate int64 `json:"last_synchronization_error_date,omitempty"`
// MaxConnections - Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook
// for update delivery
MaxConnections int `json:"max_connections,omitempty"`
// AllowedUpdates - Optional. A list of update types the bot is subscribed to. Defaults to all update types
// except chat_member
AllowedUpdates []string `json:"allowed_updates,omitempty"`
}
// User - This object represents a Telegram user or bot.
type User struct {
// ID - Unique identifier for this user or bot. This number may have more than 32 significant bits and some
// programming languages may have difficulty/silent defects in interpreting it. But it has at most 52
// significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
ID int64 `json:"id"`
// IsBot - True, if this user is a bot
IsBot bool `json:"is_bot"`
// FirstName - User's or bot's first name
FirstName string `json:"first_name"`
// LastName - Optional. User's or bot's last name
LastName string `json:"last_name,omitempty"`
// Username - Optional. User's or bot's username
Username string `json:"username,omitempty"`
// LanguageCode - Optional. IETF language tag (https://en.wikipedia.org/wiki/IETF_language_tag) of the
// user's language
LanguageCode string `json:"language_code,omitempty"`
// IsPremium - Optional. True, if this user is a Telegram Premium user
IsPremium bool `json:"is_premium,omitempty"`
// AddedToAttachmentMenu - Optional. True, if this user added the bot to the attachment menu
AddedToAttachmentMenu bool `json:"added_to_attachment_menu,omitempty"`
// CanJoinGroups - Optional. True, if the bot can be invited to groups. Returned only in getMe
// (https://core.telegram.org/bots/api#getme).
CanJoinGroups bool `json:"can_join_groups,omitempty"`
// CanReadAllGroupMessages - Optional. True, if privacy mode (https://core.telegram.org/bots#privacy-mode)
// is disabled for the bot. Returned only in getMe (https://core.telegram.org/bots/api#getme).
CanReadAllGroupMessages bool `json:"can_read_all_group_messages,omitempty"`
// SupportsInlineQueries - Optional. True, if the bot supports inline queries. Returned only in getMe
// (https://core.telegram.org/bots/api#getme).
SupportsInlineQueries bool `json:"supports_inline_queries,omitempty"`
}
// Chat - This object represents a chat.
type Chat struct {
// ID - Unique identifier for this chat. This number may have more than 32 significant bits and some
// programming languages may have difficulty/silent defects in interpreting it. But it has at most 52
// significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this
// identifier.
ID int64 `json:"id"`
// Type - Type of chat, can be either “private”, “group”, “supergroup” or “channel”
Type string `json:"type"`
// Title - Optional. Title, for supergroups, channels and group chats
Title string `json:"title,omitempty"`
// Username - Optional. Username, for private chats, supergroups and channels if available
Username string `json:"username,omitempty"`
// FirstName - Optional. First name of the other party in a private chat
FirstName string `json:"first_name,omitempty"`
// LastName - Optional. Last name of the other party in a private chat
LastName string `json:"last_name,omitempty"`
// Photo - Optional. Chat photo. Returned only in getChat (https://core.telegram.org/bots/api#getchat).
Photo *ChatPhoto `json:"photo,omitempty"`
// Bio - Optional. Bio of the other party in a private chat. Returned only in getChat
// (https://core.telegram.org/bots/api#getchat).
Bio string `json:"bio,omitempty"`
// HasPrivateForwards - Optional. True, if privacy settings of the other party in the private chat allows to
// use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat
// (https://core.telegram.org/bots/api#getchat).
HasPrivateForwards bool `json:"has_private_forwards,omitempty"`
// HasRestrictedVoiceAndVideoMessages - Optional. True, if the privacy settings of the other party restrict
// sending voice and video note messages in the private chat. Returned only in getChat
// (https://core.telegram.org/bots/api#getchat).
HasRestrictedVoiceAndVideoMessages bool `json:"has_restricted_voice_and_video_messages,omitempty"`
// JoinToSendMessages - Optional. True, if users need to join the supergroup before they can send messages.
// Returned only in getChat (https://core.telegram.org/bots/api#getchat).
JoinToSendMessages bool `json:"join_to_send_messages,omitempty"`
// JoinByRequest - Optional. True, if all users directly joining the supergroup need to be approved by
// supergroup administrators. Returned only in getChat (https://core.telegram.org/bots/api#getchat).
JoinByRequest bool `json:"join_by_request,omitempty"`
// Description - Optional. Description, for groups, supergroups and channel chats. Returned only in getChat
// (https://core.telegram.org/bots/api#getchat).
Description string `json:"description,omitempty"`
// InviteLink - Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in
// getChat (https://core.telegram.org/bots/api#getchat).
InviteLink string `json:"invite_link,omitempty"`
// PinnedMessage - Optional. The most recent pinned message (by sending date). Returned only in getChat
// (https://core.telegram.org/bots/api#getchat).
PinnedMessage *Message `json:"pinned_message,omitempty"`
// Permissions - Optional. Default chat member permissions, for groups and supergroups. Returned only in
// getChat (https://core.telegram.org/bots/api#getchat).
Permissions *ChatPermissions `json:"permissions,omitempty"`
// SlowModeDelay - Optional. For supergroups, the minimum allowed delay between consecutive messages sent by
// each unpriviledged user; in seconds. Returned only in getChat (https://core.telegram.org/bots/api#getchat).
SlowModeDelay int `json:"slow_mode_delay,omitempty"`
// MessageAutoDeleteTime - Optional. The time after which all messages sent to the chat will be
// automatically deleted; in seconds. Returned only in getChat (https://core.telegram.org/bots/api#getchat).
MessageAutoDeleteTime int `json:"message_auto_delete_time,omitempty"`
// HasProtectedContent - Optional. True, if messages from the chat can't be forwarded to other chats.
// Returned only in getChat (https://core.telegram.org/bots/api#getchat).
HasProtectedContent bool `json:"has_protected_content,omitempty"`
// StickerSetName - Optional. For supergroups, name of group sticker set. Returned only in getChat
// (https://core.telegram.org/bots/api#getchat).
StickerSetName string `json:"sticker_set_name,omitempty"`
// CanSetStickerSet - Optional. True, if the bot can change the group sticker set. Returned only in getChat
// (https://core.telegram.org/bots/api#getchat).
CanSetStickerSet bool `json:"can_set_sticker_set,omitempty"`
// LinkedChatID - Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for
// a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and
// some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52
// bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.
// Returned only in getChat (https://core.telegram.org/bots/api#getchat).
LinkedChatID int64 `json:"linked_chat_id,omitempty"`
// Location - Optional. For supergroups, the location to which the supergroup is connected. Returned only in
// getChat (https://core.telegram.org/bots/api#getchat).
Location *ChatLocation `json:"location,omitempty"`
}
// Chat types
const (
ChatTypeSender = "sender"
ChatTypePrivate = "private"
ChatTypeGroup = "group"
ChatTypeSupergroup = "supergroup"
ChatTypeChannel = "channel"
)
// Message - This object represents a message.
type Message struct {
// MessageID - Unique message identifier inside this chat
MessageID int `json:"message_id"`
// From - Optional. Sender of the message; empty for messages sent to channels. For backward compatibility,
// the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.
From *User `json:"from,omitempty"`
// SenderChat - Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself
// for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel
// for messages automatically forwarded to the discussion group. For backward compatibility, the field from
// contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.
SenderChat *Chat `json:"sender_chat,omitempty"`
// Date - Date the message was sent in Unix time
Date int64 `json:"date"`
// Chat - Conversation the message belongs to
Chat Chat `json:"chat"`
// ForwardFrom - Optional. For forwarded messages, sender of the original message
ForwardFrom *User `json:"forward_from,omitempty"`
// ForwardFromChat - Optional. For messages forwarded from channels or from anonymous administrators,
// information about the original sender chat
ForwardFromChat *Chat `json:"forward_from_chat,omitempty"`
// ForwardFromMessageID - Optional. For messages forwarded from channels, identifier of the original message
// in the channel
ForwardFromMessageID int `json:"forward_from_message_id,omitempty"`
// ForwardSignature - Optional. For forwarded messages that were originally sent in channels or by an
// anonymous chat administrator, signature of the message sender if present
ForwardSignature string `json:"forward_signature,omitempty"`
// ForwardSenderName - Optional. Sender's name for messages forwarded from users who disallow adding a link
// to their account in forwarded messages
ForwardSenderName string `json:"forward_sender_name,omitempty"`
// ForwardDate - Optional. For forwarded messages, date the original message was sent in Unix time
ForwardDate int64 `json:"forward_date,omitempty"`
// IsAutomaticForward - Optional. True, if the message is a channel post that was automatically forwarded to
// the connected discussion group
IsAutomaticForward bool `json:"is_automatic_forward,omitempty"`
// ReplyToMessage - Optional. For replies, the original message. Note that the Message object in this field
// will not contain further reply_to_message fields even if it itself is a reply.
ReplyToMessage *Message `json:"reply_to_message,omitempty"`
// ViaBot - Optional. Bot through which the message was sent
ViaBot *User `json:"via_bot,omitempty"`
// EditDate - Optional. Date the message was last edited in Unix time
EditDate int64 `json:"edit_date,omitempty"`
// HasProtectedContent - Optional. True, if the message can't be forwarded
HasProtectedContent bool `json:"has_protected_content,omitempty"`
// MediaGroupID - Optional. The unique identifier of a media message group this message belongs to
MediaGroupID string `json:"media_group_id,omitempty"`
// AuthorSignature - Optional. Signature of the post author for messages in channels, or the custom title of
// an anonymous group administrator
AuthorSignature string `json:"author_signature,omitempty"`
// Text - Optional. For text messages, the actual UTF-8 text of the message
Text string `json:"text,omitempty"`
// Entities - Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that
// appear in the text
Entities []MessageEntity `json:"entities,omitempty"`
// Animation - Optional. Message is an animation, information about the animation. For backward
// compatibility, when this field is set, the document field will also be set
Animation *Animation `json:"animation,omitempty"`
// Audio - Optional. Message is an audio file, information about the file
Audio *Audio `json:"audio,omitempty"`
// Document - Optional. Message is a general file, information about the file
Document *Document `json:"document,omitempty"`
// Photo - Optional. Message is a photo, available sizes of the photo
Photo []PhotoSize `json:"photo,omitempty"`
// Sticker - Optional. Message is a sticker, information about the sticker
Sticker *Sticker `json:"sticker,omitempty"`
// Video - Optional. Message is a video, information about the video
Video *Video `json:"video,omitempty"`
// VideoNote - Optional. Message is a video note (https://telegram.org/blog/video-messages-and-telescope),
// information about the video message
VideoNote *VideoNote `json:"video_note,omitempty"`
// Voice - Optional. Message is a voice message, information about the file
Voice *Voice `json:"voice,omitempty"`
// Caption - Optional. Caption for the animation, audio, document, photo, video or voice
Caption string `json:"caption,omitempty"`
// CaptionEntities - Optional. For messages with a caption, special entities like usernames, URLs, bot
// commands, etc. that appear in the caption
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Contact - Optional. Message is a shared contact, information about the contact
Contact *Contact `json:"contact,omitempty"`
// Dice - Optional. Message is a dice with random value
Dice *Dice `json:"dice,omitempty"`
// Game - Optional. Message is a game, information about the game. More about games »
// (https://core.telegram.org/bots/api#games)
Game *Game `json:"game,omitempty"`
// Poll - Optional. Message is a native poll, information about the poll
Poll *Poll `json:"poll,omitempty"`
// Venue - Optional. Message is a venue, information about the venue. For backward compatibility, when this
// field is set, the location field will also be set
Venue *Venue `json:"venue,omitempty"`
// Location - Optional. Message is a shared location, information about the location
Location *Location `json:"location,omitempty"`
// NewChatMembers - Optional. New members that were added to the group or supergroup and information about
// them (the bot itself may be one of these members)
NewChatMembers []User `json:"new_chat_members,omitempty"`
// LeftChatMember - Optional. A member was removed from the group, information about them (this member may
// be the bot itself)
LeftChatMember *User `json:"left_chat_member,omitempty"`
// NewChatTitle - Optional. A chat title was changed to this value
NewChatTitle string `json:"new_chat_title,omitempty"`
// NewChatPhoto - Optional. A chat photo was change to this value
NewChatPhoto []PhotoSize `json:"new_chat_photo,omitempty"`
// DeleteChatPhoto - Optional. Service message: the chat photo was deleted
DeleteChatPhoto bool `json:"delete_chat_photo,omitempty"`
// GroupChatCreated - Optional. Service message: the group has been created
GroupChatCreated bool `json:"group_chat_created,omitempty"`
// SupergroupChatCreated - Optional. Service message: the supergroup has been created. This field can't be
// received in a message coming through updates, because bot can't be a member of a supergroup when it is
// created. It can only be found in reply_to_message if someone replies to a very first message in a directly
// created supergroup.
SupergroupChatCreated bool `json:"supergroup_chat_created,omitempty"`
// ChannelChatCreated - Optional. Service message: the channel has been created. This field can't be
// received in a message coming through updates, because bot can't be a member of a channel when it is created.
// It can only be found in reply_to_message if someone replies to a very first message in a channel.
ChannelChatCreated bool `json:"channel_chat_created,omitempty"`
// MessageAutoDeleteTimerChanged - Optional. Service message: auto-delete timer settings changed in the chat
MessageAutoDeleteTimerChanged *MessageAutoDeleteTimerChanged `json:"message_auto_delete_timer_changed,omitempty"`
// MigrateToChatID - Optional. The group has been migrated to a supergroup with the specified identifier.
// This number may have more than 32 significant bits and some programming languages may have difficulty/silent
// defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or
// double-precision float type are safe for storing this identifier.
MigrateToChatID int64 `json:"migrate_to_chat_id,omitempty"`
// MigrateFromChatID - Optional. The supergroup has been migrated from a group with the specified
// identifier. This number may have more than 32 significant bits and some programming languages may have
// difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
// integer or double-precision float type are safe for storing this identifier.
MigrateFromChatID int64 `json:"migrate_from_chat_id,omitempty"`
// PinnedMessage - Optional. Specified message was pinned. Note that the Message object in this field will
// not contain further reply_to_message fields even if it is itself a reply.
PinnedMessage *Message `json:"pinned_message,omitempty"`
// Invoice - Optional. Message is an invoice for a payment (https://core.telegram.org/bots/api#payments),
// information about the invoice. More about payments » (https://core.telegram.org/bots/api#payments)
Invoice *Invoice `json:"invoice,omitempty"`
// SuccessfulPayment - Optional. Message is a service message about a successful payment, information about
// the payment. More about payments » (https://core.telegram.org/bots/api#payments)
SuccessfulPayment *SuccessfulPayment `json:"successful_payment,omitempty"`
// ConnectedWebsite - Optional. The domain name of the website on which the user has logged in. More about
// Telegram Login » (https://core.telegram.org/widgets/login)
ConnectedWebsite string `json:"connected_website,omitempty"`
// PassportData - Optional. Telegram Passport data
PassportData *PassportData `json:"passport_data,omitempty"`
// ProximityAlertTriggered - Optional. Service message. A user in the chat triggered another user's
// proximity alert while sharing Live Location.
ProximityAlertTriggered *ProximityAlertTriggered `json:"proximity_alert_triggered,omitempty"`
// VideoChatScheduled - Optional. Service message: video chat scheduled
VideoChatScheduled *VideoChatScheduled `json:"video_chat_scheduled,omitempty"`
// VideoChatStarted - Optional. Service message: video chat started
VideoChatStarted *VideoChatStarted `json:"video_chat_started,omitempty"`
// VideoChatEnded - Optional. Service message: video chat ended
VideoChatEnded *VideoChatEnded `json:"video_chat_ended,omitempty"`
// VideoChatParticipantsInvited - Optional. Service message: new participants invited to a video chat
VideoChatParticipantsInvited *VideoChatParticipantsInvited `json:"video_chat_participants_invited,omitempty"`
// WebAppData - Optional. Service message: data sent by a Web App
WebAppData *WebAppData `json:"web_app_data,omitempty"`
// ReplyMarkup - Optional. Inline keyboard attached to the message. login_url buttons are represented as
// ordinary URL buttons.
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
}
// MessageID - This object represents a unique message identifier.
type MessageID struct {
// MessageID - Unique message identifier
MessageID int `json:"message_id"`
}
// MessageEntity - This object represents one special entity in a text message. For example, hashtags,
// usernames, URLs, etc.
type MessageEntity struct {
// Type - Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag),
// “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email”
// (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic”
// (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler”
// (spoiler message), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable
// text URLs), “text_mention” (for users without usernames (https://telegram.org/blog/edit#new-mentions)),
// “custom_emoji” (for inline custom emoji stickers)
Type string `json:"type"`
// Offset - Offset in UTF-16 code units to the start of the entity
Offset int `json:"offset"`
// Length - Length of the entity in UTF-16 code units
Length int `json:"length"`
// URL - Optional. For “text_link” only, URL that will be opened after user taps on the text
URL string `json:"url,omitempty"`
// User - Optional. For “text_mention” only, the mentioned user
User *User `json:"user,omitempty"`
// Language - Optional. For “pre” only, the programming language of the entity text
Language string `json:"language,omitempty"`
// CustomEmojiID - Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use
// getCustomEmojiStickers (https://core.telegram.org/bots/api#getcustomemojistickers) to get full information
// about the sticker
CustomEmojiID string `json:"custom_emoji_id,omitempty"`
}
// MessageEntity types
const (
EntityTypeMention = "mention"
EntityTypeHashtag = "hashtag"
EntityTypeCashtag = "cashtag"
EntityTypeBotCommand = "bot_command"
EntityTypeURL = "url"
EntityTypeEmail = "email"
EntityTypePhoneNumber = "phone_number"
EntityTypeBold = "bold"
EntityTypeItalic = "italic"
EntityTypeUnderline = "underline"
EntityTypeStrikethrough = "strikethrough"
EntityTypeSpoiler = "spoiler"
EntityTypeCode = "code"
EntityTypePre = "pre"
EntityTypeTextLink = "text_link"
EntityTypeTextMention = "text_mention"
EntityTypeCustomEmoji = "custom_emoji"
)
// PhotoSize - This object represents one size of a photo or a file
// (https://core.telegram.org/bots/api#document) / sticker (https://core.telegram.org/bots/api#sticker)
// thumbnail.
type PhotoSize struct {
// FileID - Identifier for this file, which can be used to download or reuse the file
FileID string `json:"file_id"`
// FileUniqueID - Unique identifier for this file, which is supposed to be the same over time and for
// different bots. Can't be used to download or reuse the file.
FileUniqueID string `json:"file_unique_id"`
// Width - Photo width
Width int `json:"width"`
// Height - Photo height
Height int `json:"height"`
// FileSize - Optional. File size in bytes
FileSize int `json:"file_size,omitempty"`
}
// Animation - This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
type Animation struct {
// FileID - Identifier for this file, which can be used to download or reuse the file
FileID string `json:"file_id"`
// FileUniqueID - Unique identifier for this file, which is supposed to be the same over time and for
// different bots. Can't be used to download or reuse the file.
FileUniqueID string `json:"file_unique_id"`
// Width - Video width as defined by sender
Width int `json:"width"`
// Height - Video height as defined by sender
Height int `json:"height"`
// Duration - Duration of the video in seconds as defined by sender
Duration int `json:"duration"`
// Thumb - Optional. Animation thumbnail as defined by sender
Thumb *PhotoSize `json:"thumb,omitempty"`
// FileName - Optional. Original animation filename as defined by sender
FileName string `json:"file_name,omitempty"`
// MimeType - Optional. MIME type of the file as defined by sender
MimeType string `json:"mime_type,omitempty"`
// FileSize - Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may
// have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
// integer or double-precision float type are safe for storing this value.
FileSize int64 `json:"file_size,omitempty"`
}
// Audio - This object represents an audio file to be treated as music by the Telegram clients.
type Audio struct {
// FileID - Identifier for this file, which can be used to download or reuse the file
FileID string `json:"file_id"`
// FileUniqueID - Unique identifier for this file, which is supposed to be the same over time and for
// different bots. Can't be used to download or reuse the file.
FileUniqueID string `json:"file_unique_id"`
// Duration - Duration of the audio in seconds as defined by sender
Duration int `json:"duration"`
// Performer - Optional. Performer of the audio as defined by sender or by audio tags
Performer string `json:"performer,omitempty"`
// Title - Optional. Title of the audio as defined by sender or by audio tags
Title string `json:"title,omitempty"`
// FileName - Optional. Original filename as defined by sender
FileName string `json:"file_name,omitempty"`
// MimeType - Optional. MIME type of the file as defined by sender
MimeType string `json:"mime_type,omitempty"`
// FileSize - Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may
// have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
// integer or double-precision float type are safe for storing this value.
FileSize int64 `json:"file_size,omitempty"`
// Thumb - Optional. Thumbnail of the album cover to which the music file belongs
Thumb *PhotoSize `json:"thumb,omitempty"`
}
// Document - This object represents a general file (as opposed to photos
// (https://core.telegram.org/bots/api#photosize), voice messages (https://core.telegram.org/bots/api#voice) and
// audio files (https://core.telegram.org/bots/api#audio)).
type Document struct {
// FileID - Identifier for this file, which can be used to download or reuse the file
FileID string `json:"file_id"`
// FileUniqueID - Unique identifier for this file, which is supposed to be the same over time and for
// different bots. Can't be used to download or reuse the file.
FileUniqueID string `json:"file_unique_id"`
// Thumb - Optional. Document thumbnail as defined by sender
Thumb *PhotoSize `json:"thumb,omitempty"`
// FileName - Optional. Original filename as defined by sender
FileName string `json:"file_name,omitempty"`
// MimeType - Optional. MIME type of the file as defined by sender
MimeType string `json:"mime_type,omitempty"`
// FileSize - Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may
// have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
// integer or double-precision float type are safe for storing this value.
FileSize int64 `json:"file_size,omitempty"`
}
// Video - This object represents a video file.
type Video struct {
// FileID - Identifier for this file, which can be used to download or reuse the file
FileID string `json:"file_id"`
// FileUniqueID - Unique identifier for this file, which is supposed to be the same over time and for
// different bots. Can't be used to download or reuse the file.
FileUniqueID string `json:"file_unique_id"`
// Width - Video width as defined by sender
Width int `json:"width"`
// Height - Video height as defined by sender
Height int `json:"height"`
// Duration - Duration of the video in seconds as defined by sender
Duration int `json:"duration"`
// Thumb - Optional. Video thumbnail
Thumb *PhotoSize `json:"thumb,omitempty"`
// FileName - Optional. Original filename as defined by sender
FileName string `json:"file_name,omitempty"`
// MimeType - Optional. MIME type of the file as defined by sender
MimeType string `json:"mime_type,omitempty"`
// FileSize - Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may
// have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
// integer or double-precision float type are safe for storing this value.
FileSize int64 `json:"file_size,omitempty"`
}
// VideoNote - This object represents a video message
// (https://telegram.org/blog/video-messages-and-telescope) (available in Telegram apps as of v.4.0
// (https://telegram.org/blog/video-messages-and-telescope)).
type VideoNote struct {
// FileID - Identifier for this file, which can be used to download or reuse the file
FileID string `json:"file_id"`
// FileUniqueID - Unique identifier for this file, which is supposed to be the same over time and for
// different bots. Can't be used to download or reuse the file.
FileUniqueID string `json:"file_unique_id"`
// Length - Video width and height (diameter of the video message) as defined by sender
Length int `json:"length"`
// Duration - Duration of the video in seconds as defined by sender
Duration int `json:"duration"`
// Thumb - Optional. Video thumbnail
Thumb *PhotoSize `json:"thumb,omitempty"`
// FileSize - Optional. File size in bytes
FileSize int `json:"file_size,omitempty"`
}
// Voice - This object represents a voice note.
type Voice struct {
// FileID - Identifier for this file, which can be used to download or reuse the file
FileID string `json:"file_id"`
// FileUniqueID - Unique identifier for this file, which is supposed to be the same over time and for
// different bots. Can't be used to download or reuse the file.
FileUniqueID string `json:"file_unique_id"`
// Duration - Duration of the audio in seconds as defined by sender
Duration int `json:"duration"`
// MimeType - Optional. MIME type of the file as defined by sender
MimeType string `json:"mime_type,omitempty"`
// FileSize - Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may
// have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
// integer or double-precision float type are safe for storing this value.
FileSize int64 `json:"file_size,omitempty"`
}
// Contact - This object represents a phone contact.
type Contact struct {
// PhoneNumber - Contact's phone number
PhoneNumber string `json:"phone_number"`
// FirstName - Contact's first name
FirstName string `json:"first_name"`
// LastName - Optional. Contact's last name
LastName string `json:"last_name,omitempty"`
// UserID - Optional. Contact's user identifier in Telegram. This number may have more than 32 significant
// bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most
// 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
UserID int64 `json:"user_id,omitempty"`
// Vcard - Optional. Additional data about the contact in the form of a vCard
// (https://en.wikipedia.org/wiki/VCard)
Vcard string `json:"vcard,omitempty"`
}
// Dice - This object represents an animated emoji that displays a random value.
type Dice struct {
// Emoji - Emoji on which the dice throw animation is based
Emoji string `json:"emoji"`
// Value - Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀”
// and “⚽” base emoji, 1-64 for “🎰” base emoji
Value int `json:"value"`
}
// Dice emojis
const (
EmojiDice = "🎲"
EmojiDarts = "🎯"
EmojiBowling = "🎳"
EmojiBasketball = "🏀"
EmojiSoccer = "⚽"
EmojiSlotMachine = "🎰"
)
// PollOption - This object contains information about one answer option in a poll.
type PollOption struct {
// Text - Option text, 1-100 characters
Text string `json:"text"`
// VoterCount - Number of users that voted for this option
VoterCount int `json:"voter_count"`
}
// PollAnswer - This object represents an answer of a user in a non-anonymous poll.
type PollAnswer struct {
// PollID - Unique poll identifier
PollID string `json:"poll_id"`
// User - The user, who changed the answer to the poll
User User `json:"user"`
// OptionIDs - 0-based identifiers of answer options, chosen by the user. May be empty if the user retracted
// their vote.
OptionIDs []int `json:"option_ids"`
}
// Poll - This object contains information about a poll.
type Poll struct {
// ID - Unique poll identifier
ID string `json:"id"`
// Question - Poll question, 1-300 characters
Question string `json:"question"`
// Options - List of poll options
Options []PollOption `json:"options"`
// TotalVoterCount - Total number of users that voted in the poll
TotalVoterCount int `json:"total_voter_count"`
// IsClosed - True, if the poll is closed
IsClosed bool `json:"is_closed"`
// IsAnonymous - True, if the poll is anonymous
IsAnonymous bool `json:"is_anonymous"`
// Type - Poll type, currently can be “regular” or “quiz”
Type string `json:"type"`
// AllowsMultipleAnswers - True, if the poll allows multiple answers
AllowsMultipleAnswers bool `json:"allows_multiple_answers"`
// CorrectOptionID - Optional. 0-based identifier of the correct answer option. Available only for polls in
// the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.
CorrectOptionID int `json:"correct_option_id,omitempty"`
// Explanation - Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp
// icon in a quiz-style poll, 0-200 characters
Explanation string `json:"explanation,omitempty"`
// ExplanationEntities - Optional. Special entities like usernames, URLs, bot commands, etc. that appear in
// the explanation
ExplanationEntities []MessageEntity `json:"explanation_entities,omitempty"`
// OpenPeriod - Optional. Amount of time in seconds the poll will be active after creation
OpenPeriod int `json:"open_period,omitempty"`
// CloseDate - Optional. Point in time (Unix timestamp) when the poll will be automatically closed
CloseDate int64 `json:"close_date,omitempty"`
}
// Poll types
const (
PollTypeRegular = "regular"
PollTypeQuiz = "quiz"
)
// Location - This object represents a point on the map.
type Location struct {
// Longitude - Longitude as defined by sender
Longitude float64 `json:"longitude"`
// Latitude - Latitude as defined by sender
Latitude float64 `json:"latitude"`
// HorizontalAccuracy - Optional. The radius of uncertainty for the location, measured in meters; 0-1500
HorizontalAccuracy float64 `json:"horizontal_accuracy,omitempty"`
// LivePeriod - Optional. Time relative to the message sending date, during which the location can be
// updated; in seconds. For active live locations only.
LivePeriod int `json:"live_period,omitempty"`
// Heading - Optional. The direction in which user is moving, in degrees; 1-360. For active live locations
// only.
Heading int `json:"heading,omitempty"`
// ProximityAlertRadius - Optional. The maximum distance for proximity alerts about approaching another chat
// member, in meters. For sent live locations only.
ProximityAlertRadius int `json:"proximity_alert_radius,omitempty"`
}
// Venue - This object represents a venue.
type Venue struct {
// Location - Venue location. Can't be a live location
Location Location `json:"location"`
// Title - Name of the venue
Title string `json:"title"`
// Address - Address of the venue
Address string `json:"address"`
// FoursquareID - Optional. Foursquare identifier of the venue
FoursquareID string `json:"foursquare_id,omitempty"`
// FoursquareType - Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”,
// “arts_entertainment/aquarium” or “food/icecream”.)
FoursquareType string `json:"foursquare_type,omitempty"`
// GooglePlaceID - Optional. Google Places identifier of the venue
GooglePlaceID string `json:"google_place_id,omitempty"`
// GooglePlaceType - Optional. Google Places type of the venue. (See supported types
// (https://developers.google.com/places/web-service/supported_types).)
GooglePlaceType string `json:"google_place_type,omitempty"`
}
// WebAppData - Describes data sent from a Web App (https://core.telegram.org/bots/webapps) to the bot.
type WebAppData struct {
// Data - The data. Be aware that a bad client can send arbitrary data in this field.
Data string `json:"data"`
// ButtonText - Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad
// client can send arbitrary data in this field.
ButtonText string `json:"button_text"`
}
// ProximityAlertTriggered - This object represents the content of a service message, sent whenever a user in
// the chat triggers a proximity alert set by another user.
type ProximityAlertTriggered struct {
// Traveler - User that triggered the alert
Traveler User `json:"traveler"`
// Watcher - User that set the alert
Watcher User `json:"watcher"`
// Distance - The distance between the users
Distance int `json:"distance"`
}
// MessageAutoDeleteTimerChanged - This object represents a service message about a change in auto-delete
// timer settings.
type MessageAutoDeleteTimerChanged struct {
// MessageAutoDeleteTime - New auto-delete time for messages in the chat; in seconds
MessageAutoDeleteTime int `json:"message_auto_delete_time"`
}
// VideoChatScheduled - This object represents a service message about a video chat scheduled in the chat.
type VideoChatScheduled struct {
// StartDate - Point in time (Unix timestamp) when the video chat is supposed to be started by a chat
// administrator
StartDate int64 `json:"start_date"`
}
// VideoChatStarted - This object represents a service message about a video chat started in the chat.
// Currently holds no information.
type VideoChatStarted struct{}
// VideoChatEnded - This object represents a service message about a video chat ended in the chat.
type VideoChatEnded struct {
// Duration - Video chat duration in seconds
Duration int `json:"duration"`
}
// VideoChatParticipantsInvited - This object represents a service message about new members invited to a
// video chat.
type VideoChatParticipantsInvited struct {
// Users - New members that were invited to the video chat
Users []User `json:"users"`
}
// UserProfilePhotos - This object represent a user's profile pictures.
type UserProfilePhotos struct {
// TotalCount - Total number of profile pictures the target user has
TotalCount int `json:"total_count"`
// Photos - Requested profile pictures (in up to 4 sizes each)
Photos [][]PhotoSize `json:"photos"`
}
// File - This object represents a file ready to be downloaded. The file can be downloaded via the link
// https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at
// least 1 hour. When the link expires, a new one can be requested by calling getFile
// (https://core.telegram.org/bots/api#getfile).
// The maximum file size to download is 20 MB
type File struct {
// FileID - Identifier for this file, which can be used to download or reuse the file
FileID string `json:"file_id"`
// FileUniqueID - Unique identifier for this file, which is supposed to be the same over time and for
// different bots. Can't be used to download or reuse the file.
FileUniqueID string `json:"file_unique_id"`
// FileSize - Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may
// have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit
// integer or double-precision float type are safe for storing this value.
FileSize int64 `json:"file_size,omitempty"`
// FilePath - Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.
FilePath string `json:"file_path,omitempty"`
}
// WebAppInfo - Describes a Web App (https://core.telegram.org/bots/webapps).