-
Notifications
You must be signed in to change notification settings - Fork 13
/
v500.yaml
10095 lines (10095 loc) · 444 KB
/
v500.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: 5.0.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.At most one of the optional parameters can be present in any given update.'
required:
- update_id
properties:
update_id:
type: integer
message:
$ref: '#/components/schemas/Message'
edited_message:
$ref: '#/components/schemas/Message'
channel_post:
$ref: '#/components/schemas/Message'
edited_channel_post:
$ref: '#/components/schemas/Message'
inline_query:
$ref: '#/components/schemas/InlineQuery'
chosen_inline_result:
$ref: '#/components/schemas/ChosenInlineResult'
callback_query:
$ref: '#/components/schemas/CallbackQuery'
shipping_query:
$ref: '#/components/schemas/ShippingQuery'
pre_checkout_query:
$ref: '#/components/schemas/PreCheckoutQuery'
poll:
$ref: '#/components/schemas/Poll'
poll_answer:
$ref: '#/components/schemas/PollAnswer'
type: object
WebhookInfo:
description: 'Contains information about the current status of a webhook.'
required:
- url
- has_custom_certificate
- pending_update_count
properties:
url:
type: string
has_custom_certificate:
type: boolean
pending_update_count:
type: integer
ip_address:
type: string
last_error_date:
type: integer
last_error_message:
type: string
max_connections:
type: integer
allowed_updates:
type: array
items:
type: string
type: object
User:
description: 'This object represents a Telegram user or bot.'
required:
- id
- is_bot
- first_name
properties:
id:
type: integer
is_bot:
type: boolean
first_name:
type: string
last_name:
type: string
username:
type: string
language_code:
type: string
can_join_groups:
type: boolean
can_read_all_group_messages:
type: boolean
supports_inline_queries:
type: boolean
type: object
Chat:
description: 'This object represents a chat.'
required:
- id
- type
properties:
id:
type: integer
type:
type: string
title:
type: string
username:
type: string
first_name:
type: string
last_name:
type: string
photo:
$ref: '#/components/schemas/ChatPhoto'
bio:
type: string
description:
type: string
invite_link:
type: string
pinned_message:
$ref: '#/components/schemas/Message'
permissions:
$ref: '#/components/schemas/ChatPermissions'
slow_mode_delay:
type: integer
sticker_set_name:
type: string
can_set_sticker_set:
type: boolean
linked_chat_id:
type: integer
location:
$ref: '#/components/schemas/ChatLocation'
type: object
Message:
description: 'This object represents a message.'
required:
- message_id
- date
- chat
properties:
message_id:
type: integer
from:
$ref: '#/components/schemas/User'
sender_chat:
$ref: '#/components/schemas/Chat'
date:
type: integer
chat:
$ref: '#/components/schemas/Chat'
forward_from:
$ref: '#/components/schemas/User'
forward_from_chat:
$ref: '#/components/schemas/Chat'
forward_from_message_id:
type: integer
forward_signature:
type: string
forward_sender_name:
type: string
forward_date:
type: integer
reply_to_message:
$ref: '#/components/schemas/Message'
via_bot:
$ref: '#/components/schemas/User'
edit_date:
type: integer
media_group_id:
type: string
author_signature:
type: string
text:
type: string
entities:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
animation:
$ref: '#/components/schemas/Animation'
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'
video_note:
$ref: '#/components/schemas/VideoNote'
voice:
$ref: '#/components/schemas/Voice'
caption:
type: string
caption_entities:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
contact:
$ref: '#/components/schemas/Contact'
dice:
$ref: '#/components/schemas/Dice'
game:
$ref: '#/components/schemas/Game'
poll:
$ref: '#/components/schemas/Poll'
venue:
$ref: '#/components/schemas/Venue'
location:
$ref: '#/components/schemas/Location'
new_chat_members:
type: array
items:
$ref: '#/components/schemas/User'
left_chat_member:
$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
pinned_message:
$ref: '#/components/schemas/Message'
invoice:
$ref: '#/components/schemas/Invoice'
successful_payment:
$ref: '#/components/schemas/SuccessfulPayment'
connected_website:
type: string
passport_data:
$ref: '#/components/schemas/PassportData'
proximity_alert_triggered:
$ref: '#/components/schemas/ProximityAlertTriggered'
reply_markup:
$ref: '#/components/schemas/InlineKeyboardMarkup'
type: object
MessageId:
description: 'This object represents a unique message identifier.'
required:
- message_id
properties:
message_id:
type: integer
type: object
MessageEntity:
description: 'This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.'
required:
- type
- offset
- length
properties:
type:
type: string
offset:
type: integer
length:
type: integer
url:
type: string
user:
$ref: '#/components/schemas/User'
language:
type: string
type: object
PhotoSize:
description: 'This object represents one size of a photo or a file / sticker thumbnail.'
required:
- file_id
- file_unique_id
- width
- height
properties:
file_id:
type: string
file_unique_id:
type: string
width:
type: integer
height:
type: integer
file_size:
type: integer
type: object
Animation:
description: 'This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).'
required:
- file_id
- file_unique_id
- width
- height
- duration
properties:
file_id:
type: string
file_unique_id:
type: string
width:
type: integer
height:
type: integer
duration:
type: integer
thumb:
$ref: '#/components/schemas/PhotoSize'
file_name:
type: string
mime_type:
type: string
file_size:
type: integer
type: object
Audio:
description: 'This object represents an audio file to be treated as music by the Telegram clients.'
required:
- file_id
- file_unique_id
- duration
properties:
file_id:
type: string
file_unique_id:
type: string
duration:
type: integer
performer:
type: string
title:
type: string
file_name:
type: string
mime_type:
type: string
file_size:
type: integer
thumb:
$ref: '#/components/schemas/PhotoSize'
type: object
Document:
description: 'This object represents a general file (as opposed to photos, voice messages and audio files).'
required:
- file_id
- file_unique_id
properties:
file_id:
type: string
file_unique_id:
type: string
thumb:
$ref: '#/components/schemas/PhotoSize'
file_name:
type: string
mime_type:
type: string
file_size:
type: integer
type: object
Video:
description: 'This object represents a video file.'
required:
- file_id
- file_unique_id
- width
- height
- duration
properties:
file_id:
type: string
file_unique_id:
type: string
width:
type: integer
height:
type: integer
duration:
type: integer
thumb:
$ref: '#/components/schemas/PhotoSize'
file_name:
type: string
mime_type:
type: string
file_size:
type: integer
type: object
VideoNote:
description: 'This object represents a video message (available in Telegram apps as of v.4.0).'
required:
- file_id
- file_unique_id
- length
- duration
properties:
file_id:
type: string
file_unique_id:
type: string
length:
type: integer
duration:
type: integer
thumb:
$ref: '#/components/schemas/PhotoSize'
file_size:
type: integer
type: object
Voice:
description: 'This object represents a voice note.'
required:
- file_id
- file_unique_id
- duration
properties:
file_id:
type: string
file_unique_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:
- phone_number
- first_name
properties:
phone_number:
type: string
first_name:
type: string
last_name:
type: string
user_id:
type: integer
vcard:
type: string
type: object
Dice:
description: 'This object represents an animated emoji that displays a random value.'
required:
- emoji
- value
properties:
emoji:
type: string
value:
type: integer
type: object
PollOption:
description: 'This object contains information about one answer option in a poll.'
required:
- text
- voter_count
properties:
text:
type: string
voter_count:
type: integer
type: object
PollAnswer:
description: 'This object represents an answer of a user in a non-anonymous poll.'
required:
- poll_id
- user
- option_ids
properties:
poll_id:
type: string
user:
$ref: '#/components/schemas/User'
option_ids:
type: array
items:
type: integer
type: object
Poll:
description: 'This object contains information about a poll.'
required:
- id
- question
- options
- total_voter_count
- is_closed
- is_anonymous
- type
- allows_multiple_answers
properties:
id:
type: string
question:
type: string
options:
type: array
items:
$ref: '#/components/schemas/PollOption'
total_voter_count:
type: integer
is_closed:
type: boolean
is_anonymous:
type: boolean
type:
type: string
allows_multiple_answers:
type: boolean
correct_option_id:
type: integer
explanation:
type: string
explanation_entities:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
open_period:
type: integer
close_date:
type: integer
type: object
Location:
description: 'This object represents a point on the map.'
required:
- longitude
- latitude
properties:
longitude:
type: number
latitude:
type: number
horizontal_accuracy:
type: number
live_period:
type: integer
heading:
type: integer
proximity_alert_radius:
type: integer
type: object
Venue:
description: 'This object represents a venue.'
required:
- location
- title
- address
properties:
location:
$ref: '#/components/schemas/Location'
title:
type: string
address:
type: string
foursquare_id:
type: string
foursquare_type:
type: string
google_place_id:
type: string
google_place_type:
type: string
type: object
ProximityAlertTriggered:
description: 'This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.'
required:
- traveler
- watcher
- distance
properties:
traveler:
$ref: '#/components/schemas/User'
watcher:
$ref: '#/components/schemas/User'
distance:
type: integer
type: object
UserProfilePhotos:
description: "This object represent a user's profile pictures."
required:
- total_count
- photos
properties:
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:
- file_id
- file_unique_id
properties:
file_id:
type: string
file_unique_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:
- keyboard
properties:
keyboard:
type: array
items:
type: array
items:
$ref: '#/components/schemas/KeyboardButton'
resize_keyboard:
type: boolean
one_time_keyboard:
type: boolean
selective:
type: boolean
type: object
KeyboardButton:
description: 'This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields request_contact, request_location, and request_poll are mutually exclusive.'
required:
- text
properties:
text:
type: string
request_contact:
type: boolean
request_location:
type: boolean
request_poll:
$ref: '#/components/schemas/KeyboardButtonPollType'
type: object
KeyboardButtonPollType:
description: 'This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.'
properties:
type:
type: string
type: object
ReplyKeyboardRemove:
description: 'Upon receiving a message with this object, Telegram clients will remove 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:
- remove_keyboard
properties:
remove_keyboard:
type: boolean
default: true
selective:
type: boolean
type: object
InlineKeyboardMarkup:
description: 'This object represents an inline keyboard that appears right next to the message it belongs to.'
required:
- inline_keyboard
properties:
inline_keyboard:
type: array
items:
type: array
items:
$ref: '#/components/schemas/InlineKeyboardButton'
type: object
InlineKeyboardButton:
description: 'This object represents one button of an inline keyboard. You must use exactly one of the optional fields.'
required:
- text
properties:
text:
type: string
url:
type: string
login_url:
$ref: '#/components/schemas/LoginUrl'
callback_data:
type: string
switch_inline_query:
type: string
switch_inline_query_current_chat:
type: string
callback_game:
$ref: '#/components/schemas/CallbackGame'
pay:
type: boolean
type: object
LoginUrl:
description: "This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:\nTelegram apps support these buttons as of version 5.7."
required:
- url
properties:
url:
type: string
forward_text:
type: string
bot_username:
type: string
request_write_access:
type: boolean
type: object
CallbackQuery:
description: 'This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.'
required:
- id
- from
- chat_instance
properties:
id:
type: string
from:
$ref: '#/components/schemas/User'
message:
$ref: '#/components/schemas/Message'
inline_message_id:
type: string
chat_instance:
type: string
data:
type: string
game_short_name:
type: string
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:
- force_reply
properties:
force_reply:
type: boolean
default: true
selective:
type: boolean
type: object
ChatPhoto:
description: 'This object represents a chat photo.'
required:
- small_file_id
- small_file_unique_id
- big_file_id
- big_file_unique_id
properties:
small_file_id:
type: string
small_file_unique_id:
type: string
big_file_id:
type: string
big_file_unique_id:
type: string
type: object
ChatMember:
description: 'This object contains information about one member of a chat.'
required:
- user
- status
properties:
user:
$ref: '#/components/schemas/User'
status:
type: string
custom_title:
type: string
is_anonymous:
type: boolean
can_be_edited:
type: boolean
can_post_messages:
type: boolean
can_edit_messages:
type: boolean
can_delete_messages:
type: boolean
can_restrict_members:
type: boolean
can_promote_members:
type: boolean
can_change_info:
type: boolean
can_invite_users:
type: boolean
can_pin_messages:
type: boolean
is_member:
type: boolean
can_send_messages:
type: boolean
can_send_media_messages:
type: boolean
can_send_polls:
type: boolean
can_send_other_messages:
type: boolean
can_add_web_page_previews:
type: boolean
until_date:
type: integer
type: object
ChatPermissions:
description: 'Describes actions that a non-administrator user is allowed to take in a chat.'
properties:
can_send_messages:
type: boolean
can_send_media_messages:
type: boolean
can_send_polls:
type: boolean
can_send_other_messages:
type: boolean
can_add_web_page_previews:
type: boolean
can_change_info:
type: boolean
can_invite_users:
type: boolean
can_pin_messages:
type: boolean
type: object
ChatLocation:
description: 'Represents a location to which a chat is connected.'
required:
- location
- address
properties:
location:
$ref: '#/components/schemas/Location'
address:
type: string
type: object
BotCommand:
description: 'This object represents a bot command.'
required:
- command
- description
properties:
command:
type: string
description:
type: string
type: object
ResponseParameters:
description: 'Contains information about why a request was unsuccessful.'
properties:
migrate_to_chat_id:
type: integer
retry_after:
type: integer
type: object
InputMedia:
description: 'This object represents the content of a media message to be sent. It should be one of'
anyOf:
-
$ref: '#/components/schemas/InputMediaAnimation'
-
$ref: '#/components/schemas/InputMediaDocument'
-
$ref: '#/components/schemas/InputMediaAudio'
-
$ref: '#/components/schemas/InputMediaPhoto'
-
$ref: '#/components/schemas/InputMediaVideo'
InputMediaPhoto:
description: 'Represents a photo to be sent.'
required:
- type
- media
properties:
type:
type: string
default: photo
media:
type: string
caption:
type: string
parse_mode:
type: string
caption_entities:
type: array
items:
$ref: '#/components/schemas/MessageEntity'
type: object
InputMediaVideo:
description: 'Represents a video to be sent.'
required: