-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.d.ts
7450 lines (6888 loc) · 429 KB
/
index.d.ts
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
// Code generated by telegram-bot-api-types. DO NOT EDIT.
// Version 8.1
export type ChatType = 'private' | 'group' | 'supergroup' | 'channel';
export type ChatAction = 'typing' | 'upload_photo' | 'record_video' | 'upload_video' | 'record_voice' | 'upload_voice' | 'upload_document' | 'find_location' | 'record_video_note' | 'upload_video_note';
export type MessageEntityType = 'mention' | 'hashtag' | 'cashtag' | 'bot_command' | 'url' | 'email' | 'phone_number' | 'bold' | 'italic' | 'underline' | 'strikethrough' | 'code' | 'pre' | 'text_link' | 'text_mention' | 'spoiler' | 'custom_emoji';
export type ParseMode = 'Markdown' | 'MarkdownV2' | 'HTML';
/**
* https://core.telegram.org/bots/api#update
* This object represents an incoming update.
* At most one of the optional parameters can be present in any given update.
*/
export interface Update {
/** Integer | The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This identifier becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially. */
update_id: number;
/** Message | Optional. New incoming message of any kind - text, photo, sticker, etc. */
message?: Message;
/** Message | Optional. New version of a message that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot. */
edited_message?: Message;
/** Message | Optional. New incoming channel post of any kind - text, photo, sticker, etc. */
channel_post?: Message;
/** Message | Optional. New version of a channel post that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot. */
edited_channel_post?: Message;
/** BusinessConnection | Optional. The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot */
business_connection?: BusinessConnection;
/** Message | Optional. New message from a connected business account */
business_message?: Message;
/** Message | Optional. New version of a message from a connected business account */
edited_business_message?: Message;
/** BusinessMessagesDeleted | Optional. Messages were deleted from a connected business account */
deleted_business_messages?: BusinessMessagesDeleted;
/** MessageReactionUpdated | Optional. A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify "message_reaction" in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots. */
message_reaction?: MessageReactionUpdated;
/** MessageReactionCountUpdated | Optional. Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify "message_reaction_count" in the list of allowed_updates to receive these updates. The updates are grouped and can be sent with delay up to a few minutes. */
message_reaction_count?: MessageReactionCountUpdated;
/** InlineQuery | Optional. New incoming inline query */
inline_query?: InlineQuery;
/** ChosenInlineResult | Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot. */
chosen_inline_result?: ChosenInlineResult;
/** CallbackQuery | Optional. New incoming callback query */
callback_query?: CallbackQuery;
/** ShippingQuery | Optional. New incoming shipping query. Only for invoices with flexible price */
shipping_query?: ShippingQuery;
/** PreCheckoutQuery | Optional. New incoming pre-checkout query. Contains full information about checkout */
pre_checkout_query?: PreCheckoutQuery;
/** PaidMediaPurchased | Optional. A user purchased paid media with a non-empty payload sent by the bot in a non-channel chat */
purchased_paid_media?: PaidMediaPurchased;
/** Poll | Optional. New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot */
poll?: Poll;
/** 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. */
poll_answer?: PollAnswer;
/** ChatMemberUpdated | 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. */
my_chat_member?: ChatMemberUpdated;
/** ChatMemberUpdated | 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. */
chat_member?: ChatMemberUpdated;
/** 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. */
chat_join_request?: ChatJoinRequest;
/** ChatBoostUpdated | Optional. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates. */
chat_boost?: ChatBoostUpdated;
/** ChatBoostRemoved | Optional. A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates. */
removed_chat_boost?: ChatBoostRemoved;
}
/**
* https://core.telegram.org/bots/api#webhookinfo
* Describes the current status of a webhook.
*/
export interface WebhookInfo {
/** String | Webhook URL, may be empty if webhook is not set up */
url: string;
/** Boolean | True, if a custom certificate was provided for webhook certificate checks */
has_custom_certificate: boolean;
/** Integer | Number of updates awaiting delivery */
pending_update_count: number;
/** String | Optional. Currently used webhook IP address */
ip_address?: string;
/** Integer | Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook */
last_error_date?: number;
/** String | Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook */
last_error_message?: string;
/** Integer | Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters */
last_synchronization_error_date?: number;
/** Integer | Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery */
max_connections?: number;
/** Array of String | Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member */
allowed_updates?: Array<string>;
}
/**
* https://core.telegram.org/bots/api#user
* This object represents a Telegram user or bot.
*/
export interface User {
/** Integer | 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: number;
/** Boolean | True, if this user is a bot */
is_bot: boolean;
/** String | User's or bot's first name */
first_name: string;
/** String | Optional. User's or bot's last name */
last_name?: string;
/** String | Optional. User's or bot's username */
username?: string;
/** String | Optional. IETF language tag of the user's language */
language_code?: string;
/** Boolean | Optional. True, if this user is a Telegram Premium user */
is_premium?: boolean;
/** Boolean | Optional. True, if this user added the bot to the attachment menu */
added_to_attachment_menu?: boolean;
/** Boolean | Optional. True, if the bot can be invited to groups. Returned only in getMe. */
can_join_groups?: boolean;
/** Boolean | Optional. True, if privacy mode is disabled for the bot. Returned only in getMe. */
can_read_all_group_messages?: boolean;
/** Boolean | Optional. True, if the bot supports inline queries. Returned only in getMe. */
supports_inline_queries?: boolean;
/** Boolean | Optional. True, if the bot can be connected to a Telegram Business account to receive its messages. Returned only in getMe. */
can_connect_to_business?: boolean;
/** Boolean | Optional. True, if the bot has a main Web App. Returned only in getMe. */
has_main_web_app?: boolean;
}
/**
* https://core.telegram.org/bots/api#chat
* This object represents a chat.
*/
export interface Chat {
/** Integer | 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: number;
/** ChatType | Type of the chat, can be either "private", "group", "supergroup" or "channel" */
type: ChatType;
/** String | Optional. Title, for supergroups, channels and group chats */
title?: string;
/** String | Optional. Username, for private chats, supergroups and channels if available */
username?: string;
/** String | Optional. First name of the other party in a private chat */
first_name?: string;
/** String | Optional. Last name of the other party in a private chat */
last_name?: string;
/** Boolean | Optional. True, if the supergroup chat is a forum (has topics enabled) */
is_forum?: boolean;
}
/**
* https://core.telegram.org/bots/api#chatfullinfo
* This object contains full information about a chat.
*/
export interface ChatFullInfo {
/** Integer | 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: number;
/** ChatType | Type of the chat, can be either "private", "group", "supergroup" or "channel" */
type: ChatType;
/** String | Optional. Title, for supergroups, channels and group chats */
title?: string;
/** String | Optional. Username, for private chats, supergroups and channels if available */
username?: string;
/** String | Optional. First name of the other party in a private chat */
first_name?: string;
/** String | Optional. Last name of the other party in a private chat */
last_name?: string;
/** Boolean | Optional. True, if the supergroup chat is a forum (has topics enabled) */
is_forum?: boolean;
/** Integer | Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details. */
accent_color_id: number;
/** Integer | The maximum number of reactions that can be set on a message in the chat */
max_reaction_count: number;
/** ChatPhoto | Optional. Chat photo */
photo?: ChatPhoto;
/** Array of String | Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels */
active_usernames?: Array<string>;
/** Birthdate | Optional. For private chats, the date of birth of the user */
birthdate?: Birthdate;
/** BusinessIntro | Optional. For private chats with business accounts, the intro of the business */
business_intro?: BusinessIntro;
/** BusinessLocation | Optional. For private chats with business accounts, the location of the business */
business_location?: BusinessLocation;
/** BusinessOpeningHours | Optional. For private chats with business accounts, the opening hours of the business */
business_opening_hours?: BusinessOpeningHours;
/** Chat | Optional. For private chats, the personal channel of the user */
personal_chat?: Chat;
/** Array of ReactionType | Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. */
available_reactions?: Array<ReactionType>;
/** String | Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background */
background_custom_emoji_id?: string;
/** Integer | Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. */
profile_accent_color_id?: number;
/** String | Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background */
profile_background_custom_emoji_id?: string;
/** String | Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat */
emoji_status_custom_emoji_id?: string;
/** Integer | Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any */
emoji_status_expiration_date?: number;
/** String | Optional. Bio of the other party in a private chat */
bio?: string;
/** Boolean | 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 */
has_private_forwards?: boolean;
/** Boolean | Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat */
has_restricted_voice_and_video_messages?: boolean;
/** Boolean | Optional. True, if users need to join the supergroup before they can send messages */
join_to_send_messages?: boolean;
/** Boolean | Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators */
join_by_request?: boolean;
/** String | Optional. Description, for groups, supergroups and channel chats */
description?: string;
/** String | Optional. Primary invite link, for groups, supergroups and channel chats */
invite_link?: string;
/** Message | Optional. The most recent pinned message (by sending date) */
pinned_message?: Message;
/** ChatPermissions | Optional. Default chat member permissions, for groups and supergroups */
permissions?: ChatPermissions;
/** Boolean | Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. */
can_send_paid_media?: boolean;
/** Integer | Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds */
slow_mode_delay?: number;
/** Integer | Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions */
unrestrict_boost_count?: number;
/** Integer | Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds */
message_auto_delete_time?: number;
/** Boolean | Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. */
has_aggressive_anti_spam_enabled?: boolean;
/** Boolean | Optional. True, if non-administrators can only get the list of bots and administrators in the chat */
has_hidden_members?: boolean;
/** Boolean | Optional. True, if messages from the chat can't be forwarded to other chats */
has_protected_content?: boolean;
/** Boolean | Optional. True, if new chat members will have access to old messages; available only to chat administrators */
has_visible_history?: boolean;
/** String | Optional. For supergroups, name of the group sticker set */
sticker_set_name?: string;
/** Boolean | Optional. True, if the bot can change the group sticker set */
can_set_sticker_set?: boolean;
/** String | Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group. */
custom_emoji_sticker_set_name?: string;
/** Integer | 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. */
linked_chat_id?: number;
/** ChatLocation | Optional. For supergroups, the location to which the supergroup is connected */
location?: ChatLocation;
}
/**
* https://core.telegram.org/bots/api#message
* This object represents a message.
*/
export interface Message {
/** Integer | Unique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent */
message_id: number;
/** Integer | Optional. Unique identifier of a message thread to which the message belongs; for supergroups only */
message_thread_id?: number;
/** User | Optional. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats */
from?: User;
/** Chat | Optional. Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field from contains a fake sender user in non-channel chats. */
sender_chat?: Chat;
/** Integer | Optional. If the sender of the message boosted the chat, the number of boosts added by the user */
sender_boost_count?: number;
/** User | Optional. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account. */
sender_business_bot?: User;
/** Integer | Date the message was sent in Unix time. It is always a positive number, representing a valid date. */
date: number;
/** String | Optional. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier. */
business_connection_id?: string;
/** Chat | Chat the message belongs to */
chat: Chat;
/** MessageOrigin | Optional. Information about the original message for forwarded messages */
forward_origin?: MessageOrigin;
/** Boolean | Optional. True, if the message is sent to a forum topic */
is_topic_message?: boolean;
/** Boolean | Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group */
is_automatic_forward?: boolean;
/** Message | Optional. For replies in the same chat and message thread, 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. */
reply_to_message?: Message;
/** ExternalReplyInfo | Optional. Information about the message that is being replied to, which may come from another chat or forum topic */
external_reply?: ExternalReplyInfo;
/** TextQuote | Optional. For replies that quote part of the original message, the quoted part of the message */
quote?: TextQuote;
/** Story | Optional. For replies to a story, the original story */
reply_to_story?: Story;
/** User | Optional. Bot through which the message was sent */
via_bot?: User;
/** Integer | Optional. Date the message was last edited in Unix time */
edit_date?: number;
/** Boolean | Optional. True, if the message can't be forwarded */
has_protected_content?: boolean;
/** Boolean | Optional. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message */
is_from_offline?: boolean;
/** String | Optional. The unique identifier of a media message group this message belongs to */
media_group_id?: string;
/** String | Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator */
author_signature?: string;
/** String | Optional. For text messages, the actual UTF-8 text of the message */
text?: string;
/** Array of MessageEntity | Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text */
entities?: Array<MessageEntity>;
/** LinkPreviewOptions | Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed */
link_preview_options?: LinkPreviewOptions;
/** String | Optional. Unique identifier of the message effect added to the message */
effect_id?: string;
/** 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;
/** Audio | Optional. Message is an audio file, information about the file */
audio?: Audio;
/** Document | Optional. Message is a general file, information about the file */
document?: Document;
/** PaidMediaInfo | Optional. Message contains paid media; information about the paid media */
paid_media?: PaidMediaInfo;
/** Array of PhotoSize | Optional. Message is a photo, available sizes of the photo */
photo?: Array<PhotoSize>;
/** Sticker | Optional. Message is a sticker, information about the sticker */
sticker?: Sticker;
/** Story | Optional. Message is a forwarded story */
story?: Story;
/** Video | Optional. Message is a video, information about the video */
video?: Video;
/** VideoNote | Optional. Message is a video note, information about the video message */
video_note?: VideoNote;
/** Voice | Optional. Message is a voice message, information about the file */
voice?: Voice;
/** String | Optional. Caption for the animation, audio, document, paid media, photo, video or voice */
caption?: string;
/** Array of MessageEntity | Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption */
caption_entities?: Array<MessageEntity>;
/** Boolean | Optional. True, if the caption must be shown above the message media */
show_caption_above_media?: boolean;
/** Boolean | Optional. True, if the message media is covered by a spoiler animation */
has_media_spoiler?: boolean;
/** Contact | Optional. Message is a shared contact, information about the contact */
contact?: Contact;
/** Dice | Optional. Message is a dice with random value */
dice?: Dice;
/** Game | Optional. Message is a game, information about the game. More about games: https://core.telegram.org/bots/api#games */
game?: Game;
/** Poll | Optional. Message is a native poll, information about the poll */
poll?: Poll;
/** 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;
/** Location | Optional. Message is a shared location, information about the location */
location?: Location;
/** Array of User | Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members) */
new_chat_members?: Array<User>;
/** User | Optional. A member was removed from the group, information about them (this member may be the bot itself) */
left_chat_member?: User;
/** String | Optional. A chat title was changed to this value */
new_chat_title?: string;
/** Array of PhotoSize | Optional. A chat photo was change to this value */
new_chat_photo?: Array<PhotoSize>;
/** Boolean | Optional. Service message: the chat photo was deleted */
delete_chat_photo?: boolean;
/** Boolean | Optional. Service message: the group has been created */
group_chat_created?: boolean;
/** Boolean | 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. */
supergroup_chat_created?: boolean;
/** Boolean | 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. */
channel_chat_created?: boolean;
/** MessageAutoDeleteTimerChanged | Optional. Service message: auto-delete timer settings changed in the chat */
message_auto_delete_timer_changed?: MessageAutoDeleteTimerChanged;
/** Integer | 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. */
migrate_to_chat_id?: number;
/** Integer | 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. */
migrate_from_chat_id?: number;
/** MaybeInaccessibleMessage | Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply. */
pinned_message?: MaybeInaccessibleMessage;
/** Invoice | Optional. Message is an invoice for a payment, information about the invoice. More about payments: https://core.telegram.org/bots/api#payments */
invoice?: Invoice;
/** 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 */
successful_payment?: SuccessfulPayment;
/** RefundedPayment | Optional. Message is a service message about a refunded payment, information about the payment. More about payments: https://core.telegram.org/bots/api#payments */
refunded_payment?: RefundedPayment;
/** UsersShared | Optional. Service message: users were shared with the bot */
users_shared?: UsersShared;
/** ChatShared | Optional. Service message: a chat was shared with the bot */
chat_shared?: ChatShared;
/** String | Optional. The domain name of the website on which the user has logged in. More about Telegram Login: https://core.telegram.org/widgets/login */
connected_website?: string;
/** WriteAccessAllowed | Optional. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess */
write_access_allowed?: WriteAccessAllowed;
/** PassportData | Optional. Telegram Passport data */
passport_data?: PassportData;
/** ProximityAlertTriggered | Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. */
proximity_alert_triggered?: ProximityAlertTriggered;
/** ChatBoostAdded | Optional. Service message: user boosted the chat */
boost_added?: ChatBoostAdded;
/** ChatBackground | Optional. Service message: chat background set */
chat_background_set?: ChatBackground;
/** ForumTopicCreated | Optional. Service message: forum topic created */
forum_topic_created?: ForumTopicCreated;
/** ForumTopicEdited | Optional. Service message: forum topic edited */
forum_topic_edited?: ForumTopicEdited;
/** ForumTopicClosed | Optional. Service message: forum topic closed */
forum_topic_closed?: ForumTopicClosed;
/** ForumTopicReopened | Optional. Service message: forum topic reopened */
forum_topic_reopened?: ForumTopicReopened;
/** GeneralForumTopicHidden | Optional. Service message: the 'General' forum topic hidden */
general_forum_topic_hidden?: GeneralForumTopicHidden;
/** GeneralForumTopicUnhidden | Optional. Service message: the 'General' forum topic unhidden */
general_forum_topic_unhidden?: GeneralForumTopicUnhidden;
/** GiveawayCreated | Optional. Service message: a scheduled giveaway was created */
giveaway_created?: GiveawayCreated;
/** Giveaway | Optional. The message is a scheduled giveaway message */
giveaway?: Giveaway;
/** GiveawayWinners | Optional. A giveaway with public winners was completed */
giveaway_winners?: GiveawayWinners;
/** GiveawayCompleted | Optional. Service message: a giveaway without public winners was completed */
giveaway_completed?: GiveawayCompleted;
/** VideoChatScheduled | Optional. Service message: video chat scheduled */
video_chat_scheduled?: VideoChatScheduled;
/** VideoChatStarted | Optional. Service message: video chat started */
video_chat_started?: VideoChatStarted;
/** VideoChatEnded | Optional. Service message: video chat ended */
video_chat_ended?: VideoChatEnded;
/** VideoChatParticipantsInvited | Optional. Service message: new participants invited to a video chat */
video_chat_participants_invited?: VideoChatParticipantsInvited;
/** WebAppData | Optional. Service message: data sent by a Web App */
web_app_data?: WebAppData;
/** InlineKeyboardMarkup | Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons. */
reply_markup?: InlineKeyboardMarkup;
}
/**
* https://core.telegram.org/bots/api#messageid
* This object represents a unique message identifier.
*/
export interface MessageId {
/** Integer | Unique message identifier. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent */
message_id: number;
}
/**
* https://core.telegram.org/bots/api#inaccessiblemessage
* This object describes a message that was deleted or is otherwise inaccessible to the bot.
*/
export interface InaccessibleMessage {
/** Chat | Chat the message belonged to */
chat: Chat;
/** Integer | Unique message identifier inside the chat */
message_id: number;
/** Integer | Always 0. The field can be used to differentiate regular and inaccessible messages. */
date: number;
}
/**
* https://core.telegram.org/bots/api#maybeinaccessiblemessage
* This object describes a message that can be inaccessible to the bot. It can be one of
* - Message
* - InaccessibleMessage
*/
export type MaybeInaccessibleMessage = Message | InaccessibleMessage;
/**
* https://core.telegram.org/bots/api#messageentity
* This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
*/
export interface MessageEntity {
/** MessageEntityType | Type of the entity. Currently, can be "mention" (@username), "hashtag" (#hashtag or #hashtag@chatusername), "cashtag" ($USD or $USD@chatusername), "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), "blockquote" (block quotation), "expandable_blockquote" (collapsed-by-default block quotation), "code" (monowidth string), "pre" (monowidth block), "text_link" (for clickable text URLs), "text_mention" (for users without usernames), "custom_emoji" (for inline custom emoji stickers) */
type: MessageEntityType;
/** Integer | Offset in UTF-16 code units to the start of the entity */
offset: number;
/** Integer | Length of the entity in UTF-16 code units */
length: number;
/** String | Optional. For "text_link" only, URL that will be opened after user taps on the text */
url?: string;
/** User | Optional. For "text_mention" only, the mentioned user */
user?: User;
/** String | Optional. For "pre" only, the programming language of the entity text */
language?: string;
/** String | Optional. For "custom_emoji" only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker */
custom_emoji_id?: string;
}
/**
* https://core.telegram.org/bots/api#textquote
* This object contains information about the quoted part of a message that is replied to by the given message.
*/
export interface TextQuote {
/** String | Text of the quoted part of a message that is replied to by the given message */
text: string;
/** Array of MessageEntity | Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes. */
entities?: Array<MessageEntity>;
/** Integer | Approximate quote position in the original message in UTF-16 code units as specified by the sender */
position: number;
/** Boolean | Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server. */
is_manual?: boolean;
}
/**
* https://core.telegram.org/bots/api#externalreplyinfo
* This object contains information about a message that is being replied to, which may come from another chat or forum topic.
*/
export interface ExternalReplyInfo {
/** MessageOrigin | Origin of the message replied to by the given message */
origin: MessageOrigin;
/** Chat | Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel. */
chat?: Chat;
/** Integer | Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel. */
message_id?: number;
/** LinkPreviewOptions | Optional. Options used for link preview generation for the original message, if it is a text message */
link_preview_options?: LinkPreviewOptions;
/** Animation | Optional. Message is an animation, information about the animation */
animation?: Animation;
/** Audio | Optional. Message is an audio file, information about the file */
audio?: Audio;
/** Document | Optional. Message is a general file, information about the file */
document?: Document;
/** PaidMediaInfo | Optional. Message contains paid media; information about the paid media */
paid_media?: PaidMediaInfo;
/** Array of PhotoSize | Optional. Message is a photo, available sizes of the photo */
photo?: Array<PhotoSize>;
/** Sticker | Optional. Message is a sticker, information about the sticker */
sticker?: Sticker;
/** Story | Optional. Message is a forwarded story */
story?: Story;
/** Video | Optional. Message is a video, information about the video */
video?: Video;
/** VideoNote | Optional. Message is a video note, information about the video message */
video_note?: VideoNote;
/** Voice | Optional. Message is a voice message, information about the file */
voice?: Voice;
/** Boolean | Optional. True, if the message media is covered by a spoiler animation */
has_media_spoiler?: boolean;
/** Contact | Optional. Message is a shared contact, information about the contact */
contact?: Contact;
/** Dice | Optional. Message is a dice with random value */
dice?: Dice;
/** Game | Optional. Message is a game, information about the game. More about games: https://core.telegram.org/bots/api#games */
game?: Game;
/** Giveaway | Optional. Message is a scheduled giveaway, information about the giveaway */
giveaway?: Giveaway;
/** GiveawayWinners | Optional. A giveaway with public winners was completed */
giveaway_winners?: GiveawayWinners;
/** Invoice | Optional. Message is an invoice for a payment, information about the invoice. More about payments: https://core.telegram.org/bots/api#payments */
invoice?: Invoice;
/** Location | Optional. Message is a shared location, information about the location */
location?: Location;
/** Poll | Optional. Message is a native poll, information about the poll */
poll?: Poll;
/** Venue | Optional. Message is a venue, information about the venue */
venue?: Venue;
}
/**
* https://core.telegram.org/bots/api#replyparameters
* Describes reply parameters for the message that is being sent.
*/
export interface ReplyParameters {
/** Integer | Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified */
message_id: number;
/** Integer or String | Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account. */
chat_id?: number | string;
/** Boolean | Optional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account. */
allow_sending_without_reply?: boolean;
/** String | Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message. */
quote?: string;
/** String | Optional. Mode for parsing entities in the quote. See formatting options for more details. */
quote_parse_mode?: string;
/** Array of MessageEntity | Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode. */
quote_entities?: Array<MessageEntity>;
/** Integer | Optional. Position of the quote in the original message in UTF-16 code units */
quote_position?: number;
}
/**
* https://core.telegram.org/bots/api#messageorigin
* This object describes the origin of a message. It can be one of
* - MessageOriginUser
* - MessageOriginHiddenUser
* - MessageOriginChat
* - MessageOriginChannel
*/
export type MessageOrigin = MessageOriginUser | MessageOriginHiddenUser | MessageOriginChat | MessageOriginChannel;
/**
* https://core.telegram.org/bots/api#messageoriginuser
* The message was originally sent by a known user.
*/
export interface MessageOriginUser {
/** String | Type of the message origin, always "user" */
type: 'user';
/** Integer | Date the message was sent originally in Unix time */
date: number;
/** User | User that sent the message originally */
sender_user: User;
}
/**
* https://core.telegram.org/bots/api#messageoriginhiddenuser
* The message was originally sent by an unknown user.
*/
export interface MessageOriginHiddenUser {
/** String | Type of the message origin, always "hidden_user" */
type: 'hidden_user';
/** Integer | Date the message was sent originally in Unix time */
date: number;
/** String | Name of the user that sent the message originally */
sender_user_name: string;
}
/**
* https://core.telegram.org/bots/api#messageoriginchat
* The message was originally sent on behalf of a chat to a group chat.
*/
export interface MessageOriginChat {
/** String | Type of the message origin, always "chat" */
type: 'chat';
/** Integer | Date the message was sent originally in Unix time */
date: number;
/** Chat | Chat that sent the message originally */
sender_chat: Chat;
/** String | Optional. For messages originally sent by an anonymous chat administrator, original message author signature */
author_signature?: string;
}
/**
* https://core.telegram.org/bots/api#messageoriginchannel
* The message was originally sent to a channel chat.
*/
export interface MessageOriginChannel {
/** String | Type of the message origin, always "channel" */
type: 'channel';
/** Integer | Date the message was sent originally in Unix time */
date: number;
/** Chat | Channel chat to which the message was originally sent */
chat: Chat;
/** Integer | Unique message identifier inside the chat */
message_id: number;
/** String | Optional. Signature of the original post author */
author_signature?: string;
}
/**
* https://core.telegram.org/bots/api#photosize
* This object represents one size of a photo or a file / sticker thumbnail.
*/
export interface PhotoSize {
/** String | Identifier for this file, which can be used to download or reuse the file */
file_id: string;
/** String | 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. */
file_unique_id: string;
/** Integer | Photo width */
width: number;
/** Integer | Photo height */
height: number;
/** Integer | Optional. File size in bytes */
file_size?: number;
}
/**
* https://core.telegram.org/bots/api#animation
* This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
*/
export interface Animation {
/** String | Identifier for this file, which can be used to download or reuse the file */
file_id: string;
/** String | 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. */
file_unique_id: string;
/** Integer | Video width as defined by the sender */
width: number;
/** Integer | Video height as defined by the sender */
height: number;
/** Integer | Duration of the video in seconds as defined by the sender */
duration: number;
/** PhotoSize | Optional. Animation thumbnail as defined by the sender */
thumbnail?: PhotoSize;
/** String | Optional. Original animation filename as defined by the sender */
file_name?: string;
/** String | Optional. MIME type of the file as defined by the sender */
mime_type?: string;
/** Integer | 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. */
file_size?: number;
}
/**
* https://core.telegram.org/bots/api#audio
* This object represents an audio file to be treated as music by the Telegram clients.
*/
export interface Audio {
/** String | Identifier for this file, which can be used to download or reuse the file */
file_id: string;
/** String | 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. */
file_unique_id: string;
/** Integer | Duration of the audio in seconds as defined by the sender */
duration: number;
/** String | Optional. Performer of the audio as defined by the sender or by audio tags */
performer?: string;
/** String | Optional. Title of the audio as defined by the sender or by audio tags */
title?: string;
/** String | Optional. Original filename as defined by the sender */
file_name?: string;
/** String | Optional. MIME type of the file as defined by the sender */
mime_type?: string;
/** Integer | 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. */
file_size?: number;
/** PhotoSize | Optional. Thumbnail of the album cover to which the music file belongs */
thumbnail?: PhotoSize;
}
/**
* https://core.telegram.org/bots/api#document
* This object represents a general file (as opposed to photos, voice messages and audio files).
*/
export interface Document {
/** String | Identifier for this file, which can be used to download or reuse the file */
file_id: string;
/** String | 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. */
file_unique_id: string;
/** PhotoSize | Optional. Document thumbnail as defined by the sender */
thumbnail?: PhotoSize;
/** String | Optional. Original filename as defined by the sender */
file_name?: string;
/** String | Optional. MIME type of the file as defined by the sender */
mime_type?: string;
/** Integer | 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. */
file_size?: number;
}
/**
* https://core.telegram.org/bots/api#story
* This object represents a story.
*/
export interface Story {
/** Chat | Chat that posted the story */
chat: Chat;
/** Integer | Unique identifier for the story in the chat */
id: number;
}
/**
* https://core.telegram.org/bots/api#video
* This object represents a video file.
*/
export interface Video {
/** String | Identifier for this file, which can be used to download or reuse the file */
file_id: string;
/** String | 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. */
file_unique_id: string;
/** Integer | Video width as defined by the sender */
width: number;
/** Integer | Video height as defined by the sender */
height: number;
/** Integer | Duration of the video in seconds as defined by the sender */
duration: number;
/** PhotoSize | Optional. Video thumbnail */
thumbnail?: PhotoSize;
/** String | Optional. Original filename as defined by the sender */
file_name?: string;
/** String | Optional. MIME type of the file as defined by the sender */
mime_type?: string;
/** Integer | 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. */
file_size?: number;
}
/**
* https://core.telegram.org/bots/api#videonote
* This object represents a video message (available in Telegram apps as of v.4.0).
*/
export interface VideoNote {
/** String | Identifier for this file, which can be used to download or reuse the file */
file_id: string;
/** String | 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. */
file_unique_id: string;
/** Integer | Video width and height (diameter of the video message) as defined by the sender */
length: number;
/** Integer | Duration of the video in seconds as defined by the sender */
duration: number;
/** PhotoSize | Optional. Video thumbnail */
thumbnail?: PhotoSize;
/** Integer | Optional. File size in bytes */
file_size?: number;
}
/**
* https://core.telegram.org/bots/api#voice
* This object represents a voice note.
*/
export interface Voice {
/** String | Identifier for this file, which can be used to download or reuse the file */
file_id: string;
/** String | 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. */
file_unique_id: string;
/** Integer | Duration of the audio in seconds as defined by the sender */
duration: number;
/** String | Optional. MIME type of the file as defined by the sender */
mime_type?: string;
/** Integer | 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. */
file_size?: number;
}
/**
* https://core.telegram.org/bots/api#paidmediainfo
* Describes the paid media added to a message.
*/
export interface PaidMediaInfo {
/** Integer | The number of Telegram Stars that must be paid to buy access to the media */
star_count: number;
/** Array of PaidMedia | Information about the paid media */
paid_media: Array<PaidMedia>;
}
/**
* https://core.telegram.org/bots/api#paidmedia
* This object describes paid media. Currently, it can be one of
* - PaidMediaPreview
* - PaidMediaPhoto
* - PaidMediaVideo
*/
export type PaidMedia = PaidMediaPreview | PaidMediaPhoto | PaidMediaVideo;
/**
* https://core.telegram.org/bots/api#paidmediapreview
* The paid media isn't available before the payment.
*/
export interface PaidMediaPreview {
/** String | Type of the paid media, always "preview" */
type: 'preview';
/** Integer | Optional. Media width as defined by the sender */
width?: number;
/** Integer | Optional. Media height as defined by the sender */
height?: number;
/** Integer | Optional. Duration of the media in seconds as defined by the sender */
duration?: number;
}
/**
* https://core.telegram.org/bots/api#paidmediaphoto
* The paid media is a photo.
*/
export interface PaidMediaPhoto {
/** String | Type of the paid media, always "photo" */
type: 'photo';
/** Array of PhotoSize | The photo */
photo: Array<PhotoSize>;
}
/**
* https://core.telegram.org/bots/api#paidmediavideo
* The paid media is a video.
*/
export interface PaidMediaVideo {
/** String | Type of the paid media, always "video" */
type: 'video';
/** Video | The video */
video: Video;
}
/**
* https://core.telegram.org/bots/api#contact
* This object represents a phone contact.
*/
export interface Contact {
/** String | Contact's phone number */
phone_number: string;
/** String | Contact's first name */
first_name: string;
/** String | Optional. Contact's last name */
last_name?: string;
/** Integer | 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. */
user_id?: number;
/** String | Optional. Additional data about the contact in the form of a vCard */
vcard?: string;
}
/**
* https://core.telegram.org/bots/api#dice
* This object represents an animated emoji that displays a random value.
*/
export interface Dice {
/** String | Emoji on which the dice throw animation is based */
emoji: string;
/** Integer | Value of the dice, 1-6 for "🎲", "🎯" and "🎳" base emoji, 1-5 for "🏀" and "⚽" base emoji, 1-64 for "🎰" base emoji */
value: number;
}
/**
* https://core.telegram.org/bots/api#polloption
* This object contains information about one answer option in a poll.
*/
export interface PollOption {
/** String | Option text, 1-100 characters */
text: string;
/** Array of MessageEntity | Optional. Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts */
text_entities?: Array<MessageEntity>;
/** Integer | Number of users that voted for this option */
voter_count: number;
}
/**
* https://core.telegram.org/bots/api#inputpolloption
* This object contains information about one answer option in a poll to be sent.
*/
export interface InputPollOption {
/** String | Option text, 1-100 characters */
text: string;
/** String | Optional. Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed */
text_parse_mode?: string;
/** Array of MessageEntity | Optional. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode */
text_entities?: Array<MessageEntity>;
}
/**
* https://core.telegram.org/bots/api#pollanswer
* This object represents an answer of a user in a non-anonymous poll.
*/
export interface PollAnswer {
/** String | Unique poll identifier */
poll_id: string;
/** Chat | Optional. The chat that changed the answer to the poll, if the voter is anonymous */
voter_chat?: Chat;
/** User | Optional. The user that changed the answer to the poll, if the voter isn't anonymous */
user?: User;
/** Array of Integer | 0-based identifiers of chosen answer options. May be empty if the vote was retracted. */
option_ids: Array<number>;
}
/**
* https://core.telegram.org/bots/api#poll
* This object contains information about a poll.
*/
export interface Poll {
/** String | Unique poll identifier */
id: string;
/** String | Poll question, 1-300 characters */
question: string;
/** Array of MessageEntity | Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions */
question_entities?: Array<MessageEntity>;
/** Array of PollOption | List of poll options */
options: Array<PollOption>;
/** Integer | Total number of users that voted in the poll */
total_voter_count: number;
/** Boolean | True, if the poll is closed */
is_closed: boolean;
/** Boolean | True, if the poll is anonymous */
is_anonymous: boolean;
/** String | Poll type, currently can be "regular" or "quiz" */
type: string;
/** Boolean | True, if the poll allows multiple answers */
allows_multiple_answers: boolean;
/** Integer | 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. */
correct_option_id?: number;
/** String | 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;
/** Array of MessageEntity | Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation */
explanation_entities?: Array<MessageEntity>;
/** Integer | Optional. Amount of time in seconds the poll will be active after creation */
open_period?: number;
/** Integer | Optional. Point in time (Unix timestamp) when the poll will be automatically closed */
close_date?: number;
}
/**
* https://core.telegram.org/bots/api#location
* This object represents a point on the map.
*/
export interface Location {
/** Float | Latitude as defined by the sender */
latitude: number;
/** Float | Longitude as defined by the sender */
longitude: number;
/** Float | Optional. The radius of uncertainty for the location, measured in meters; 0-1500 */
horizontal_accuracy?: number;
/** Integer | Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only. */
live_period?: number;
/** Integer | Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only. */
heading?: number;
/** Integer | Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
proximity_alert_radius?: number;
}
/**
* https://core.telegram.org/bots/api#venue
* This object represents a venue.
*/
export interface Venue {
/** Location | Venue location. Can't be a live location */
location: Location;
/** String | Name of the venue */
title: string;
/** String | Address of the venue */
address: string;
/** String | Optional. Foursquare identifier of the venue */
foursquare_id?: string;
/** String | Optional. Foursquare type of the venue. (For example, "arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".) */
foursquare_type?: string;
/** String | Optional. Google Places identifier of the venue */
google_place_id?: string;
/** String | Optional. Google Places type of the venue. (See supported types.) */
google_place_type?: string;
}
/**
* https://core.telegram.org/bots/api#webappdata
* Describes data sent from a Web App to the bot.
*/
export interface WebAppData {
/** String | The data. Be aware that a bad client can send arbitrary data in this field. */
data: string;
/** String | 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. */
button_text: string;
}
/**
* https://core.telegram.org/bots/api#proximityalerttriggered