-
Notifications
You must be signed in to change notification settings - Fork 13
/
v180.yaml
2391 lines (2391 loc) · 104 KB
/
v180.yaml
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
openapi: 3.0.0
info:
title: 'Telegram Bot API'
description: 'Auto-generated OpenAPI schema by TGScraper.'
version: 1.8.0
servers:
-
url: 'https://api.telegram.org/bot{token}'
variables:
token:
default: '1234:AAbbcc'
description: "Bot's unique authentication token, given by @BotFather."
externalDocs:
description: 'Official Telegram Bot API documentation.'
url: 'https://core.telegram.org/bots/api'
components:
responses:
BadRequest:
description: 'Bad request, you have provided malformed data.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Unauthorized:
description: 'The authorization token is invalid or it has been revoked.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Forbidden:
description: 'This action is forbidden.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
NotFound:
description: 'The specified resource was not found.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
Conflict:
description: 'There is a conflict with another instance using webhook or polling.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
TooManyRequests:
description: "You're doing too many requests, retry after a while."
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
ServerError:
description: 'The bot API is experiencing some issues, try again later.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
UnknownError:
description: 'An unknown error occurred.'
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Response:
type: object
description: 'Represents the default response object.'
required:
- ok
properties:
ok:
type: boolean
Success:
description: 'Request was successful, the result is returned.'
allOf:
-
$ref: '#/components/schemas/Response'
-
type: object
required:
- result
properties:
result:
type: object
Error:
description: 'Request was unsuccessful, so an error occurred.'
allOf:
-
$ref: '#/components/schemas/Response'
-
type: object
required:
- error_code
- description
properties:
error_code:
type: integer
description:
type: string
parameters:
$ref: '#/components/schemas/ResponseParameters'
Update:
description: 'This object represents an incoming update.Only one of the optional parameters can be present in any given update.'
required:
- Field
- update_id
properties:
Field:
$ref: '#/components/schemas/Type'
update_id:
type: integer
message:
$ref: '#/components/schemas/Message'
inline_query:
$ref: '#/components/schemas/InlineQuery'
type: object
User:
description: 'This object represents a Telegram user or bot.'
required:
- Field
- id
- first_name
properties:
Field:
$ref: '#/components/schemas/Type'
id:
type: integer
first_name:
type: string
last_name:
type: string
username:
type: string
type: object
Chat:
description: 'This object represents a chat.'
required:
- Field
- id
- type
properties:
Field:
$ref: '#/components/schemas/Type'
id:
type: integer
type:
type: string
title:
type: string
username:
type: string
first_name:
type: string
last_name:
type: string
type: object
Message:
description: 'This object represents a message.'
required:
- Field
- message_id
- date
- chat
properties:
Field:
$ref: '#/components/schemas/Type'
message_id:
type: integer
from:
$ref: '#/components/schemas/User'
date:
type: integer
chat:
$ref: '#/components/schemas/Chat'
forward_from:
$ref: '#/components/schemas/User'
forward_date:
type: integer
reply_to_message:
$ref: '#/components/schemas/Message'
text:
type: string
audio:
$ref: '#/components/schemas/Audio'
document:
$ref: '#/components/schemas/Document'
photo:
type: array
items:
$ref: '#/components/schemas/PhotoSize'
sticker:
$ref: '#/components/schemas/Sticker'
video:
$ref: '#/components/schemas/Video'
voice:
$ref: '#/components/schemas/Voice'
caption:
type: string
contact:
$ref: '#/components/schemas/Contact'
location:
$ref: '#/components/schemas/Location'
new_chat_participant:
$ref: '#/components/schemas/User'
left_chat_participant:
$ref: '#/components/schemas/User'
new_chat_title:
type: string
new_chat_photo:
type: array
items:
$ref: '#/components/schemas/PhotoSize'
delete_chat_photo:
type: boolean
default: true
group_chat_created:
type: boolean
default: true
supergroup_chat_created:
type: boolean
default: true
channel_chat_created:
type: boolean
default: true
migrate_to_chat_id:
type: integer
migrate_from_chat_id:
type: integer
type: object
PhotoSize:
description: 'This object represents one size of a photo or a file / sticker thumbnail.'
required:
- Field
- file_id
- width
- height
properties:
Field:
$ref: '#/components/schemas/Type'
file_id:
type: string
width:
type: integer
height:
type: integer
file_size:
type: integer
type: object
Audio:
description: 'This object represents an audio file to be treated as music by the Telegram clients.'
required:
- Field
- file_id
- duration
properties:
Field:
$ref: '#/components/schemas/Type'
file_id:
type: string
duration:
type: integer
performer:
type: string
title:
type: string
mime_type:
type: string
file_size:
type: integer
type: object
Document:
description: 'This object represents a general file (as opposed to photos, voice messages and audio files).'
required:
- Field
- file_id
properties:
Field:
$ref: '#/components/schemas/Type'
file_id:
type: string
thumb:
$ref: '#/components/schemas/PhotoSize'
file_name:
type: string
mime_type:
type: string
file_size:
type: integer
type: object
Sticker:
description: 'This object represents a sticker.'
required:
- Field
- file_id
- width
- height
properties:
Field:
$ref: '#/components/schemas/Type'
file_id:
type: string
width:
type: integer
height:
type: integer
thumb:
$ref: '#/components/schemas/PhotoSize'
file_size:
type: integer
type: object
Video:
description: 'This object represents a video file.'
required:
- Field
- file_id
- width
- height
- duration
properties:
Field:
$ref: '#/components/schemas/Type'
file_id:
type: string
width:
type: integer
height:
type: integer
duration:
type: integer
thumb:
$ref: '#/components/schemas/PhotoSize'
mime_type:
type: string
file_size:
type: integer
type: object
Voice:
description: 'This object represents a voice note.'
required:
- Field
- file_id
- duration
properties:
Field:
$ref: '#/components/schemas/Type'
file_id:
type: string
duration:
type: integer
mime_type:
type: string
file_size:
type: integer
type: object
Contact:
description: 'This object represents a phone contact.'
required:
- Field
- phone_number
- first_name
properties:
Field:
$ref: '#/components/schemas/Type'
phone_number:
type: string
first_name:
type: string
last_name:
type: string
user_id:
type: integer
type: object
Location:
description: 'This object represents a point on the map.'
required:
- Field
- longitude
- latitude
properties:
Field:
$ref: '#/components/schemas/Type'
longitude:
type: number
latitude:
type: number
type: object
UserProfilePhotos:
description: "This object represent a user's profile pictures."
required:
- Field
- total_count
- photos
properties:
Field:
$ref: '#/components/schemas/Type'
total_count:
type: integer
photos:
type: array
items:
type: array
items:
$ref: '#/components/schemas/PhotoSize'
type: object
File:
description: 'This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.'
required:
- Field
- file_id
properties:
Field:
$ref: '#/components/schemas/Type'
file_id:
type: string
file_size:
type: integer
file_path:
type: string
type: object
ReplyKeyboardMarkup:
description: 'This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).'
required:
- Field
- keyboard
properties:
Field:
$ref: '#/components/schemas/Type'
keyboard:
type: array
items:
type: array
items:
type: string
resize_keyboard:
type: boolean
one_time_keyboard:
type: boolean
selective:
type: boolean
type: object
ReplyKeyboardHide:
description: 'Upon receiving a message with this object, Telegram clients will hide the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).'
required:
- Field
- hide_keyboard
properties:
Field:
$ref: '#/components/schemas/Type'
hide_keyboard:
type: boolean
default: true
selective:
type: boolean
type: object
ForceReply:
description: "Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode."
required:
- Field
- force_reply
properties:
Field:
$ref: '#/components/schemas/Type'
force_reply:
type: boolean
default: true
selective:
type: boolean
type: object
InputFile:
description: 'This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.'
type: object
InlineQuery:
description: 'This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.'
required:
- Field
- id
- from
- query
- offset
properties:
Field:
$ref: '#/components/schemas/Type'
id:
type: string
from:
$ref: '#/components/schemas/User'
query:
type: string
offset:
type: string
type: object
InlineQueryResult:
description: 'This object represents one result of an inline query. Telegram clients currently support results of the following 5 types:'
anyOf:
-
$ref: '#/components/schemas/InlineQueryResultArticle'
-
$ref: '#/components/schemas/InlineQueryResultPhoto'
-
$ref: '#/components/schemas/InlineQueryResultGif'
-
$ref: '#/components/schemas/InlineQueryResultMpeg4Gif'
-
$ref: '#/components/schemas/InlineQueryResultVideo'
InlineQueryResultArticle:
description: 'Represents a link to an article or web page.'
required:
- Field
- type
- id
- title
- message_text
properties:
Field:
$ref: '#/components/schemas/Type'
type:
type: string
default: article
id:
type: string
title:
type: string
message_text:
type: string
parse_mode:
type: string
disable_web_page_preview:
type: boolean
url:
type: string
hide_url:
type: boolean
description:
type: string
thumb_url:
type: string
thumb_width:
type: integer
thumb_height:
type: integer
type: object
InlineQueryResultPhoto:
description: 'Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can provide message_text to send it instead of photo.'
required:
- Field
- type
- id
- photo_url
- thumb_url
properties:
Field:
$ref: '#/components/schemas/Type'
type:
type: string
default: photo
id:
type: string
photo_url:
type: string
photo_width:
type: integer
photo_height:
type: integer
thumb_url:
type: string
title:
type: string
description:
type: string
caption:
type: string
message_text:
type: string
parse_mode:
type: string
disable_web_page_preview:
type: boolean
type: object
InlineQueryResultGif:
description: 'Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can provide message_text to send it instead of the animation.'
required:
- Field
- type
- id
- gif_url
- thumb_url
properties:
Field:
$ref: '#/components/schemas/Type'
type:
type: string
default: gif
id:
type: string
gif_url:
type: string
gif_width:
type: integer
gif_height:
type: integer
thumb_url:
type: string
title:
type: string
caption:
type: string
message_text:
type: string
parse_mode:
type: string
disable_web_page_preview:
type: boolean
type: object
InlineQueryResultMpeg4Gif:
description: 'Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can provide message_text to send it instead of the animation.'
required:
- Field
- type
- id
- mpeg4_url
- thumb_url
properties:
Field:
$ref: '#/components/schemas/Type'
type:
type: string
default: mpeg4_gif
id:
type: string
mpeg4_url:
type: string
mpeg4_width:
type: integer
mpeg4_height:
type: integer
thumb_url:
type: string
title:
type: string
caption:
type: string
message_text:
type: string
parse_mode:
type: string
disable_web_page_preview:
type: boolean
type: object
InlineQueryResultVideo:
description: 'Represents link to a page containing an embedded video player or a video file.'
required:
- Field
- type
- id
- video_url
- mime_type
- message_text
- thumb_url
- title
properties:
Field:
$ref: '#/components/schemas/Type'
type:
type: string
default: video
id:
type: string
video_url:
type: string
mime_type:
type: string
message_text:
type: string
parse_mode:
type: string
disable_web_page_preview:
type: boolean
video_width:
type: integer
video_height:
type: integer
video_duration:
type: integer
thumb_url:
type: string
title:
type: string
description:
type: string
type: object
paths:
/getUpdates:
description: 'Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.'
post:
requestBody:
content:
application/json:
schema:
type: object
properties:
Parameters:
$ref: '#/components/schemas/Type'
offset:
type: integer
limit:
type: integer
default: 100
timeout:
type: integer
application/x-www-form-urlencoded:
schema:
type: object
properties:
Parameters:
$ref: '#/components/schemas/Type'
offset:
type: integer
limit:
type: integer
default: 100
timeout:
type: integer
multipart/form-data:
schema:
type: object
properties:
Parameters:
$ref: '#/components/schemas/Type'
offset:
type: integer
limit:
type: integer
default: 100
timeout:
type: integer
responses:
200:
description: 'Request was successful, the result is returned.'
content:
application/json:
schema:
allOf:
-
$ref: '#/components/schemas/Success'
-
type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/Update'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
409:
$ref: '#/components/responses/Conflict'
429:
$ref: '#/components/responses/TooManyRequests'
5XX:
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/UnknownError'
/setWebhook:
description: "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.\nIf you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot‘s token, you can be pretty sure it’s us."
post:
requestBody:
content:
application/json:
schema:
type: object
properties:
Parameters:
$ref: '#/components/schemas/Type'
url:
type: string
certificate:
$ref: '#/components/schemas/InputFile'
application/x-www-form-urlencoded:
schema:
type: object
properties:
Parameters:
$ref: '#/components/schemas/Type'
url:
type: string
certificate:
$ref: '#/components/schemas/InputFile'
multipart/form-data:
schema:
type: object
properties:
Parameters:
$ref: '#/components/schemas/Type'
url:
type: string
certificate:
$ref: '#/components/schemas/InputFile'
responses:
200:
description: 'Request was successful, the result is returned.'
content:
application/json:
schema:
allOf:
-
$ref: '#/components/schemas/Success'
-
type: object
properties:
result: { }
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
409:
$ref: '#/components/responses/Conflict'
429:
$ref: '#/components/responses/TooManyRequests'
5XX:
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/UnknownError'
/getMe:
description: "A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object."
post:
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
multipart/form-data:
schema:
type: object
responses:
200:
description: 'Request was successful, the result is returned.'
content:
application/json:
schema:
allOf:
-
$ref: '#/components/schemas/Success'
-
type: object
properties:
result:
$ref: '#/components/schemas/User'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
409:
$ref: '#/components/responses/Conflict'
429:
$ref: '#/components/responses/TooManyRequests'
5XX:
$ref: '#/components/responses/ServerError'
default:
$ref: '#/components/responses/UnknownError'
/sendMessage:
description: 'Use this method to send text messages. On success, the sent Message is returned.'
post:
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
Parameters:
$ref: '#/components/schemas/Type'
chat_id:
anyOf:
-
type: integer
-
type: string
text:
type: string
parse_mode:
type: string
disable_web_page_preview:
type: boolean
reply_to_message_id:
type: integer
reply_markup:
anyOf:
-
$ref: '#/components/schemas/ReplyKeyboardMarkup'
-
$ref: '#/components/schemas/ReplyKeyboardHide'
-
$ref: '#/components/schemas/ForceReply'
required:
- chat_id
- text
application/x-www-form-urlencoded:
schema:
type: object
properties:
Parameters:
$ref: '#/components/schemas/Type'
chat_id:
anyOf:
-
type: integer
-
type: string
text:
type: string
parse_mode:
type: string
disable_web_page_preview:
type: boolean
reply_to_message_id:
type: integer
reply_markup:
anyOf:
-
$ref: '#/components/schemas/ReplyKeyboardMarkup'
-
$ref: '#/components/schemas/ReplyKeyboardHide'
-
$ref: '#/components/schemas/ForceReply'
required:
- chat_id
- text
multipart/form-data:
schema:
type: object
properties:
Parameters:
$ref: '#/components/schemas/Type'
chat_id:
anyOf:
-
type: integer
-
type: string
text:
type: string
parse_mode:
type: string
disable_web_page_preview:
type: boolean
reply_to_message_id:
type: integer
reply_markup:
anyOf:
-
$ref: '#/components/schemas/ReplyKeyboardMarkup'
-
$ref: '#/components/schemas/ReplyKeyboardHide'
-
$ref: '#/components/schemas/ForceReply'
required:
- chat_id
- text
responses:
200:
description: 'Request was successful, the result is returned.'
content:
application/json:
schema:
allOf:
-
$ref: '#/components/schemas/Success'
-
type: object
properties:
result:
$ref: '#/components/schemas/Message'
400:
$ref: '#/components/responses/BadRequest'
401:
$ref: '#/components/responses/Unauthorized'
403:
$ref: '#/components/responses/Forbidden'
404:
$ref: '#/components/responses/NotFound'
409:
$ref: '#/components/responses/Conflict'