-
-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathmethods.ts
1843 lines (1696 loc) · 119 KB
/
methods.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
// deno-lint-ignore-file ban-types
import type { InlineQueryResult, InlineQueryResultsButton } from "./inline.ts";
import type {
ForceReply,
InlineKeyboardMarkup,
ReplyKeyboardMarkup,
ReplyKeyboardRemove,
} from "./markup.ts";
import type {
BotCommand,
ChatAdministratorRights,
ChatFromGetChat,
ChatInviteLink,
ChatMember,
ChatMemberAdministrator,
ChatMemberOwner,
ChatPermissions,
File,
ForumTopic,
ReactionType,
UserChatBoosts,
UserFromGetMe,
UserProfilePhotos,
WebhookInfo,
} from "./manage.ts";
import type {
GameHighScore,
LinkPreviewOptions,
MaskPosition,
Message,
MessageEntity,
MessageId,
ParseMode,
Poll,
ReplyParameters,
SentWebAppMessage,
Sticker,
StickerSet,
} from "./message.ts";
import type { PassportElementError } from "./passport.ts";
import type { LabeledPrice, ShippingOption } from "./payment.ts";
import type {
BotCommandScope,
BotDescription,
BotName,
BotShortDescription,
MenuButton,
} from "./settings.ts";
import type { Update } from "./update.ts";
/** Extracts the parameters of a given method name */
type Params<F, M extends keyof ApiMethods<F>> = Parameters<ApiMethods<F>[M]>;
/** Utility type providing the argument type for the given method name or `{}` if the method does not take any parameters */
export type Opts<F> = {
[M in keyof ApiMethods<F>]: Params<F, M>[0] extends undefined ? {}
: NonNullable<Params<F, M>[0]>;
};
export type Ret<F> = {
[M in keyof ApiMethods<F>]: ReturnType<ApiMethods<F>[M]>;
};
type UnionKeys<T> = T extends T ? keyof T : never;
/** Wrapper type to bundle all methods of the Telegram Bot API */
export type ApiMethods<F> = {
/** Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
Notes
1. This method will not work if an outgoing webhook is set up.
2. In order to avoid getting duplicate updates, recalculate offset after each server response. */
getUpdates(args?: {
/** Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten. */
offset?: number;
/** Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. */
limit?: number;
/** Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only. */
timeout?: number;
/** A list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.
Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time. */
allowed_updates?: ReadonlyArray<Exclude<UnionKeys<Update>, "update_id">>;
}): Update[];
/** Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.
Notes
1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.
3. Ports currently supported for Webhooks: 443, 80, 88, 8443.
If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks. */
setWebhook(args: {
/** HTTPS URL to send updates to. Use an empty string to remove webhook integration */
url: string;
/** Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. */
certificate?: F;
/** The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS */
ip_address?: string;
/** The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput. */
max_connections?: number;
/** A list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.
Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time. */
allowed_updates?: ReadonlyArray<Exclude<UnionKeys<Update>, "update_id">>;
/** Pass True to drop all pending updates */
drop_pending_updates?: boolean;
/** A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. */
secret_token?: string;
}): true;
/** Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. */
deleteWebhook(args?: {
/** Pass True to drop all pending updates */
drop_pending_updates?: boolean;
}): true;
/** Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty. */
getWebhookInfo(): WebhookInfo;
/** A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object. */
getMe(): UserFromGetMe;
/** Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters. */
logOut(): true;
/** Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters. */
close(): true;
/** Use this method to send text messages. On success, the sent Message is returned. */
sendMessage(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Text of the message to be sent, 1-4096 characters after entities parsing */
text: string;
/** Mode for parsing entities in the message text. See formatting options for more details. */
parse_mode?: ParseMode;
/** A list of special entities that appear in message text, which can be specified instead of parse_mode */
entities?: MessageEntity[];
/** Link preview generation options for the message */
link_preview_options?: LinkPreviewOptions;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.TextMessage;
/** Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned. */
forwardMessage(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Unique identifier for the chat where the original message was sent (or channel username in the format `@channelusername`) */
from_chat_id: number | string;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the forwarded message from forwarding and saving */
protect_content?: boolean;
/** Message identifier in the chat specified in from_chat_id */
message_id: number;
}): Message;
/** Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned. */
forwardMessages(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Unique identifier for the chat where the original messages were sent (or channel username in the format `@channelusername`) */
from_chat_id: number | string;
/** Identifiers of 1-100 messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order. */
message_ids: number[];
/** Sends the messages silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the forwarded messages from forwarding and saving */
protect_content?: boolean;
}): MessageId[];
/** Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success. */
copyMessage(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Unique identifier for the chat where the original message was sent (or channel username in the format `@channelusername`) */
from_chat_id: number | string;
/** Message identifier in the chat specified in from_chat_id */
message_id: number;
/** New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept */
caption?: string;
/** Mode for parsing entities in the new caption. See formatting options for more details. */
parse_mode?: string;
/** A list of special entities that appear in the new caption, which can be specified instead of parse_mode */
caption_entities?: MessageEntity[];
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): MessageId;
/** Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned. */
copyMessages(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Unique identifier for the chat where the original messages were sent (or channel username in the format `@channelusername`) */
from_chat_id: number | string;
/** Identifiers of 1-100 messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order. */
message_ids: number[];
/** Sends the messages silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent messages from forwarding and saving */
protect_content?: boolean;
/** Pass True to copy the messages without their captions */
remove_caption?: boolean;
}): MessageId[];
/** Use this method to send photos. On success, the sent Message is returned. */
sendPhoto(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. */
photo: F | string;
/** Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing */
caption?: string;
/** Mode for parsing entities in the photo caption. See formatting options for more details. */
parse_mode?: ParseMode;
/** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
caption_entities?: MessageEntity[];
/** Pass True if the photo needs to be covered with a spoiler animation */
has_spoiler?: boolean;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.PhotoMessage;
/** Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
For sending voice messages, use the sendVoice method instead. */
sendAudio(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. */
audio: F | string;
/** Audio caption, 0-1024 characters after entities parsing */
caption?: string;
/** Mode for parsing entities in the audio caption. See formatting options for more details. */
parse_mode?: ParseMode;
/** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
caption_entities?: MessageEntity[];
/** Duration of the audio in seconds */
duration?: number;
/** Performer */
performer?: string;
/** Track name */
title?: string;
/** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
thumbnail?: F;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.AudioMessage;
/** Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future. */
sendDocument(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. */
document: F | string;
/** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
thumbnail?: F;
/** Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing */
caption?: string;
/** Mode for parsing entities in the document caption. See formatting options for more details. */
parse_mode?: ParseMode;
/** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
caption_entities?: MessageEntity[];
/** Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album. */
disable_content_type_detection?: boolean;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.DocumentMessage;
/** Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. */
sendVideo(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. */
video: F | string;
/** Duration of sent video in seconds */
duration?: number;
/** Video width */
width?: number;
/** Video height */
height?: number;
/** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
thumbnail?: F;
/** Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing */
caption?: string;
/** Mode for parsing entities in the video caption. See formatting options for more details. */
parse_mode?: ParseMode;
/** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
caption_entities?: MessageEntity[];
/** Pass True if the video needs to be covered with a spoiler animation */
has_spoiler?: boolean;
/** Pass True if the uploaded video is suitable for streaming */
supports_streaming?: boolean;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.VideoMessage;
/** Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. */
sendAnimation(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. */
animation: F | string;
/** Duration of sent animation in seconds */
duration?: number;
/** Animation width */
width?: number;
/** Animation height */
height?: number;
/** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
thumbnail?: F;
/** Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing */
caption?: string;
/** Mode for parsing entities in the animation caption. See formatting options for more details. */
parse_mode?: ParseMode;
/** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
caption_entities?: MessageEntity[];
/** Pass True if the animation needs to be covered with a spoiler animation */
has_spoiler?: boolean;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.AnimationMessage;
/** Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. */
sendVoice(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. */
voice: F | string;
/** Voice message caption, 0-1024 characters after entities parsing */
caption?: string;
/** Mode for parsing entities in the voice message caption. See formatting options for more details. */
parse_mode?: ParseMode;
/** A list of special entities that appear in the caption, which can be specified instead of parse_mode */
caption_entities?: MessageEntity[];
/** Duration of the voice message in seconds */
duration?: number;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.VoiceMessage;
/** Use this method to send video messages. On success, the sent Message is returned.
As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. */
sendVideoNote(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data.. Sending video notes by a URL is currently unsupported */
video_note: F | string;
/** Duration of sent video in seconds */
duration?: number;
/** Video width and height, i.e. diameter of the video message */
length?: number;
/** Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass "attach://<file_attach_name>" if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. */
thumbnail?: F;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.VideoNoteMessage;
/** Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned. */
sendMediaGroup(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** An array describing messages to be sent, must include 2-10 items */
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
media: ReadonlyArray<
| InputMediaAudio<F>
| InputMediaDocument<F>
| InputMediaPhoto<F>
| InputMediaVideo<F>
>;
/** Sends the messages silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent messages from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
}): Array<
| Message.AudioMessage
| Message.DocumentMessage
| Message.PhotoMessage
| Message.VideoMessage
>;
/** Use this method to send point on the map. On success, the sent Message is returned. */
sendLocation(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Latitude of the location */
latitude: number;
/** Longitude of the location */
longitude: number;
/** The radius of uncertainty for the location, measured in meters; 0-1500 */
horizontal_accuracy?: number;
/** Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400. */
live_period?: number;
/** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
heading?: number;
/** The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
proximity_alert_radius?: number;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.LocationMessage;
/** Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. */
editMessageLiveLocation(args: {
/** Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id?: number | string;
/** Required if inline_message_id is not specified. Identifier of the message to edit */
message_id?: number;
/** Required if chat_id and message_id are not specified. Identifier of the inline message */
inline_message_id?: string;
/** Latitude of new location */
latitude: number;
/** Longitude of new location */
longitude: number;
/** The radius of uncertainty for the location, measured in meters; 0-1500 */
horizontal_accuracy?: number;
/** The direction in which user is moving, in degrees; 1-360. For active live locations only. */
heading?: number;
/** The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. */
proximity_alert_radius?: number;
/** An object for a new inline keyboard. */
reply_markup?: InlineKeyboardMarkup;
}): (Update.Edited & Message.LocationMessage) | true;
/** Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned. */
stopMessageLiveLocation(args: {
/** Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id?: number | string;
/** Required if inline_message_id is not specified. Identifier of the message with live location to stop */
message_id?: number;
/** Required if chat_id and message_id are not specified. Identifier of the inline message */
inline_message_id?: string;
/** An object for a new inline keyboard. */
reply_markup?: InlineKeyboardMarkup;
}): (Update.Edited & Message.LocationMessage) | true;
/** Use this method to send information about a venue. On success, the sent Message is returned. */
sendVenue(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Latitude of the venue */
latitude: number;
/** Longitude of the venue */
longitude: number;
/** Name of the venue */
title: string;
/** Address of the venue */
address: string;
/** Foursquare identifier of the venue */
foursquare_id?: string;
/** Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) */
foursquare_type?: string;
/** Google Places identifier of the venue */
google_place_id?: string;
/** Google Places type of the venue. (See supported types.) */
google_place_type?: string;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.VenueMessage;
/** Use this method to send phone contacts. On success, the sent Message is returned. */
sendContact(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Contact's phone number */
phone_number: string;
/** Contact's first name */
first_name: string;
/** Contact's last name */
last_name?: string;
/** Additional data about the contact in the form of a vCard, 0-2048 bytes */
vcard?: string;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.ContactMessage;
/** Use this method to send a native poll. On success, the sent Message is returned. */
sendPoll(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Poll question, 1-300 characters */
question: string;
/** A list of answer options, 2-10 strings 1-100 characters each */
options: readonly string[];
/** True, if the poll needs to be anonymous, defaults to True */
is_anonymous?: boolean;
/** Poll type, “quiz” or “regular”, defaults to “regular” */
type?: "quiz" | "regular";
/** True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False */
allows_multiple_answers?: boolean;
/** 0-based identifier of the correct answer option, required for polls in quiz mode */
correct_option_id?: number;
/** 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 with at most 2 line feeds after entities parsing */
explanation?: string;
/** Mode for parsing entities in the explanation. See formatting options for more details. */
explanation_parse_mode?: ParseMode;
/** A list of special entities that appear in the poll explanation, which can be specified instead of parse_mode */
explanation_entities?: MessageEntity[];
/** Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date. */
open_period?: number;
/** Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period. */
close_date?: number;
/** Pass True if the poll needs to be immediately closed. This can be useful for poll preview. */
is_closed?: boolean;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding and saving */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.PollMessage;
/** Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned. */
sendDice(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier for the target message thread (topic) of the forum; for forum supergroups only */
message_thread_id?: number;
/** Emoji on which the dice throw animation is based. Currently, must be one of "🎲", "🎯", "🏀", "⚽", "🎳", or "🎰". Dice can have values 1-6 for "🎲", "🎯" and "🎳", values 1-5 for "🏀" and "⚽", and values 1-64 for "🎰". Defaults to "🎲" */
emoji?: string;
/** Sends the message silently. Users will receive a notification with no sound. */
disable_notification?: boolean;
/** Protects the contents of the sent message from forwarding */
protect_content?: boolean;
/** Description of the message to reply to */
reply_parameters?: ReplyParameters;
/** Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. */
reply_markup?:
| InlineKeyboardMarkup
| ReplyKeyboardMarkup
| ReplyKeyboardRemove
| ForceReply;
}): Message.DiceMessage;
/** Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of "Retrieving image, please wait...", the bot may use sendChatAction with action = upload_photo. The user will see a "sending photo" status for the bot.
We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive. */
sendChatAction(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes. */
action:
| "typing"
| "upload_photo"
| "record_video"
| "upload_video"
| "record_voice"
| "upload_voice"
| "upload_document"
| "choose_sticker"
| "find_location"
| "record_video_note"
| "upload_video_note";
/** Unique identifier for the target message thread; supergroups only */
message_thread_id?: number;
}): true;
/** Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. In albums, bots must react to the first message. Returns True on success. */
setMessageReaction(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Identifier of the target message */
message_id: number;
/** New list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. */
reaction?: ReactionType[];
/** Pass True to set the reaction with a big animation */
is_big?: Boolean;
}): true;
/** Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object. */
getUserProfilePhotos(args: {
/** Unique identifier of the target user */
user_id: number;
/** Sequential number of the first photo to be returned. By default, all photos are returned. */
offset?: number;
/** Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. */
limit?: number;
}): UserProfilePhotos;
/** Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. 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 again.
Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received. */
getFile(args: {
/** File identifier to get information about */
file_id: string;
}): File;
/** Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
* @deprecated Use `banChatMember` instead. */
kickChatMember: ApiMethods<F>["banChatMember"];
/** Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. */
banChatMember(args: {
/** Unique identifier for the target group or username of the target supergroup or channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier of the target user */
user_id: number;
/** Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only. */
until_date?: number;
/** Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels. */
revoke_messages?: boolean;
}): true;
/** Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success. */
unbanChatMember(args: {
/** Unique identifier for the target group or username of the target supergroup or channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier of the target user */
user_id: number;
/** Do nothing if the user is not banned */
only_if_banned?: boolean;
}): true;
/** Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success. */
restrictChatMember(args: {
/** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
chat_id: number | string;
/** Unique identifier of the target user */
user_id: number;
/** An object for new user permissions */
permissions: ChatPermissions;
/** Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. */
use_independent_chat_permissions?: boolean;
/** Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever */
until_date?: number;
}): true;
/** Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success. */
promoteChatMember(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier of the target user */
user_id: number;
/** Pass True if the administrator's presence in the chat is hidden */
is_anonymous?: boolean;
/** Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege */
can_manage_chat?: boolean;
/** Pass True if the administrator can create channel posts, channels only */
can_post_messages?: boolean;
/** Pass True if the administrator can edit messages of other users and can pin messages, channels only */
can_edit_messages?: boolean;
/** Pass True if the administrator can delete messages of other users */
can_delete_messages?: boolean;
/** Pass True if the administrator can manage video chats */
can_manage_video_chats?: boolean;
/** Pass True if the administrator can restrict, ban or unban chat members */
can_restrict_members?: boolean;
/** Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him) */
can_promote_members?: boolean;
/** Pass True if the administrator can change chat title, photo and other settings */
can_change_info?: boolean;
/** Pass True if the administrator can invite new users to the chat */
can_invite_users?: boolean;
/** Pass True if the administrator can pin messages, supergroups only */
can_pin_messages?: boolean;
/** Pass True if the administrator can post stories to the chat */
can_post_stories?: boolean;
/** Pass True if the administrator can edit stories posted by other users */
can_edit_stories?: boolean;
/** Pass True if the administrator can delete stories posted by other users */
can_delete_stories?: boolean;
/** Pass True if the user is allowed to create, rename, close, and reopen forum topics, supergroups only */
can_manage_topics?: boolean;
}): true;
/** Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success. */
setChatAdministratorCustomTitle(args: {
/** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
chat_id: number | string;
/** Unique identifier of the target user */
user_id: number;
/** New custom title for the administrator; 0-16 characters, emoji are not allowed */
custom_title: string;
}): true;
/** Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success. */
banChatSenderChat(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier of the target sender chat */
sender_chat_id: number;
}): true;
/** Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success. */
unbanChatSenderChat(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier of the target sender chat */
sender_chat_id: number;
}): true;
/** Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success. */
setChatPermissions(args: {
/** Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) */
chat_id: number | string;
/** An object for new default chat permissions */
permissions: ChatPermissions;
/** Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission. */
use_independent_chat_permissions?: boolean;
}): true;
/** Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again. */
exportChatInviteLink(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
}): string;
/** Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object. */
createChatInviteLink(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Invite link name; 0-32 characters */
name?: string;
/** Point in time (Unix timestamp) when the link will expire */
expire_date?: number;
/** The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 */
member_limit?: number;
/** True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified */
creates_join_request?: boolean;
}): ChatInviteLink;
/** Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object. */
editChatInviteLink(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** The invite link to edit */
invite_link: string;
/** Invite link name; 0-32 characters */
name?: string;
/** Point in time (Unix timestamp) when the link will expire */
expire_date?: number;
/** The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 */
member_limit?: number;
/** True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified */
creates_join_request?: boolean;
}): ChatInviteLink;
/** Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object. */
revokeChatInviteLink(args: {
/** Unique identifier of the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** The invite link to revoke */
invite_link: string;
}): ChatInviteLink;
/** Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success. */
approveChatJoinRequest(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier of the target user */
user_id: number;
}): true;
/** Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success. */
declineChatJoinRequest(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Unique identifier of the target user */
user_id: number;
}): true;
/** Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. */
setChatPhoto(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** New chat photo, uploaded using multipart/form-data */
photo: F;
}): true;
/** Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. */
deleteChatPhoto(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
}): true;
/** Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. */
setChatTitle(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** New chat title, 1-128 characters */
title: string;
}): true;
/** Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success. */
setChatDescription(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** New chat description, 0-255 characters */
description?: string;
}): true;
/** Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success. */
pinChatMessage(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Identifier of a message to pin */
message_id: number;
/** Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats. */
disable_notification?: boolean;
}): true;
/** Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success. */
unpinChatMessage(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
/** Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned. */
message_id?: number;
}): true;
/** Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success. */
unpinAllChatMessages(args: {
/** Unique identifier for the target chat or username of the target channel (in the format `@channelusername`) */
chat_id: number | string;
}): true;
/** Use this method for your bot to leave a group, supergroup or channel. Returns True on success. */
leaveChat(args: {
/** Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`) */
chat_id: number | string;
}): true;
/** Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success. */
getChat(args: {
/** Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`) */
chat_id: number | string;
}): ChatFromGetChat;
/** Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects. */
getChatAdministrators(args: {
/** Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`) */
chat_id: number | string;