-
Notifications
You must be signed in to change notification settings - Fork 13
/
v570.yaml
8510 lines (8510 loc) · 361 KB
/
v570.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
version: 5.7.0
types:
-
name: Update
description: 'This object represents an incoming update.At most one of the optional parameters can be present in any given update.'
fields:
-
name: update_id
types:
- int
optional: false
description: "The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially."
-
name: message
types:
- Message
optional: true
description: 'Optional. New incoming message of any kind — text, photo, sticker, etc.'
-
name: edited_message
types:
- Message
optional: true
description: 'Optional. New version of a message that is known to the bot and was edited'
-
name: channel_post
types:
- Message
optional: true
description: 'Optional. New incoming channel post of any kind — text, photo, sticker, etc.'
-
name: edited_channel_post
types:
- Message
optional: true
description: 'Optional. New version of a channel post that is known to the bot and was edited'
-
name: inline_query
types:
- InlineQuery
optional: true
description: 'Optional. New incoming inline query'
-
name: chosen_inline_result
types:
- ChosenInlineResult
optional: true
description: 'Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.'
-
name: callback_query
types:
- CallbackQuery
optional: true
description: 'Optional. New incoming callback query'
-
name: shipping_query
types:
- ShippingQuery
optional: true
description: 'Optional. New incoming shipping query. Only for invoices with flexible price'
-
name: pre_checkout_query
types:
- PreCheckoutQuery
optional: true
description: 'Optional. New incoming pre-checkout query. Contains full information about checkout'
-
name: poll
types:
- Poll
optional: true
description: 'Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot'
-
name: poll_answer
types:
- PollAnswer
optional: true
description: 'Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.'
-
name: my_chat_member
types:
- ChatMemberUpdated
optional: true
description: "Optional. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user."
-
name: chat_member
types:
- ChatMemberUpdated
optional: true
description: "Optional. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates."
-
name: chat_join_request
types:
- ChatJoinRequest
optional: true
description: 'Optional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.'
extended_by: { }
-
name: WebhookInfo
description: 'Contains information about the current status of a webhook.'
fields:
-
name: url
types:
- string
optional: false
description: 'Webhook URL, may be empty if webhook is not set up'
-
name: has_custom_certificate
types:
- bool
optional: false
description: 'True, if a custom certificate was provided for webhook certificate checks'
-
name: pending_update_count
types:
- int
optional: false
description: 'Number of updates awaiting delivery'
-
name: ip_address
types:
- string
optional: true
description: 'Optional. Currently used webhook IP address'
-
name: last_error_date
types:
- int
optional: true
description: 'Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook'
-
name: last_error_message
types:
- string
optional: true
description: 'Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook'
-
name: max_connections
types:
- int
optional: true
description: 'Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery'
-
name: allowed_updates
types:
- Array<string>
optional: true
description: 'Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member'
extended_by: { }
-
name: User
description: 'This object represents a Telegram user or bot.'
fields:
-
name: id
types:
- int
optional: false
description: 'Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.'
-
name: is_bot
types:
- bool
optional: false
description: 'True, if this user is a bot'
-
name: first_name
types:
- string
optional: false
description: "User's or bot's first name"
-
name: last_name
types:
- string
optional: true
description: "Optional. User's or bot's last name"
-
name: username
types:
- string
optional: true
description: "Optional. User's or bot's username"
-
name: language_code
types:
- string
optional: true
description: "Optional. IETF language tag of the user's language"
-
name: can_join_groups
types:
- bool
optional: true
description: 'Optional. True, if the bot can be invited to groups. Returned only in getMe.'
-
name: can_read_all_group_messages
types:
- bool
optional: true
description: 'Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.'
-
name: supports_inline_queries
types:
- bool
optional: true
description: 'Optional. True, if the bot supports inline queries. Returned only in getMe.'
extended_by: { }
-
name: Chat
description: 'This object represents a chat.'
fields:
-
name: id
types:
- int
optional: false
description: 'Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.'
-
name: type
types:
- string
optional: false
description: 'Type of chat, can be either “private”, “group”, “supergroup” or “channel”'
-
name: title
types:
- string
optional: true
description: 'Optional. Title, for supergroups, channels and group chats'
-
name: username
types:
- string
optional: true
description: 'Optional. Username, for private chats, supergroups and channels if available'
-
name: first_name
types:
- string
optional: true
description: 'Optional. First name of the other party in a private chat'
-
name: last_name
types:
- string
optional: true
description: 'Optional. Last name of the other party in a private chat'
-
name: photo
types:
- ChatPhoto
optional: true
description: 'Optional. Chat photo. Returned only in getChat.'
-
name: bio
types:
- string
optional: true
description: 'Optional. Bio of the other party in a private chat. Returned only in getChat.'
-
name: has_private_forwards
types:
- bool
optional: true
description: 'Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user. Returned only in getChat.'
default: true
-
name: description
types:
- string
optional: true
description: 'Optional. Description, for groups, supergroups and channel chats. Returned only in getChat.'
-
name: invite_link
types:
- string
optional: true
description: 'Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.'
-
name: pinned_message
types:
- Message
optional: true
description: 'Optional. The most recent pinned message (by sending date). Returned only in getChat.'
-
name: permissions
types:
- ChatPermissions
optional: true
description: 'Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat.'
-
name: slow_mode_delay
types:
- int
optional: true
description: 'Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat.'
-
name: message_auto_delete_time
types:
- int
optional: true
description: 'Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.'
-
name: has_protected_content
types:
- bool
optional: true
description: "Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat."
default: true
-
name: sticker_set_name
types:
- string
optional: true
description: 'Optional. For supergroups, name of group sticker set. Returned only in getChat.'
-
name: can_set_sticker_set
types:
- bool
optional: true
description: 'Optional. True, if the bot can change the group sticker set. Returned only in getChat.'
default: true
-
name: linked_chat_id
types:
- int
optional: true
description: 'Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat.'
-
name: location
types:
- ChatLocation
optional: true
description: 'Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat.'
extended_by: { }
-
name: Message
description: 'This object represents a message.'
fields:
-
name: message_id
types:
- int
optional: false
description: 'Unique message identifier inside this chat'
-
name: from
types:
- User
optional: true
description: 'Optional. Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.'
-
name: sender_chat
types:
- Chat
optional: true
description: 'Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.'
-
name: date
types:
- int
optional: false
description: 'Date the message was sent in Unix time'
-
name: chat
types:
- Chat
optional: false
description: 'Conversation the message belongs to'
-
name: forward_from
types:
- User
optional: true
description: 'Optional. For forwarded messages, sender of the original message'
-
name: forward_from_chat
types:
- Chat
optional: true
description: 'Optional. For messages forwarded from channels or from anonymous administrators, information about the original sender chat'
-
name: forward_from_message_id
types:
- int
optional: true
description: 'Optional. For messages forwarded from channels, identifier of the original message in the channel'
-
name: forward_signature
types:
- string
optional: true
description: 'Optional. For forwarded messages that were originally sent in channels or by an anonymous chat administrator, signature of the message sender if present'
-
name: forward_sender_name
types:
- string
optional: true
description: "Optional. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages"
-
name: forward_date
types:
- int
optional: true
description: 'Optional. For forwarded messages, date the original message was sent in Unix time'
-
name: is_automatic_forward
types:
- bool
optional: true
description: 'Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group'
default: true
-
name: reply_to_message
types:
- Message
optional: true
description: 'Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.'
-
name: via_bot
types:
- User
optional: true
description: 'Optional. Bot through which the message was sent'
-
name: edit_date
types:
- int
optional: true
description: 'Optional. Date the message was last edited in Unix time'
-
name: has_protected_content
types:
- bool
optional: true
description: "Optional. True, if the message can't be forwarded"
default: true
-
name: media_group_id
types:
- string
optional: true
description: 'Optional. The unique identifier of a media message group this message belongs to'
-
name: author_signature
types:
- string
optional: true
description: 'Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator'
-
name: text
types:
- string
optional: true
description: 'Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters'
-
name: entities
types:
- Array<MessageEntity>
optional: true
description: 'Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text'
-
name: animation
types:
- Animation
optional: true
description: 'Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set'
-
name: audio
types:
- Audio
optional: true
description: 'Optional. Message is an audio file, information about the file'
-
name: document
types:
- Document
optional: true
description: 'Optional. Message is a general file, information about the file'
-
name: photo
types:
- Array<PhotoSize>
optional: true
description: 'Optional. Message is a photo, available sizes of the photo'
-
name: sticker
types:
- Sticker
optional: true
description: 'Optional. Message is a sticker, information about the sticker'
-
name: video
types:
- Video
optional: true
description: 'Optional. Message is a video, information about the video'
-
name: video_note
types:
- VideoNote
optional: true
description: 'Optional. Message is a video note, information about the video message'
-
name: voice
types:
- Voice
optional: true
description: 'Optional. Message is a voice message, information about the file'
-
name: caption
types:
- string
optional: true
description: 'Optional. Caption for the animation, audio, document, photo, video or voice, 0-1024 characters'
-
name: caption_entities
types:
- Array<MessageEntity>
optional: true
description: 'Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption'
-
name: contact
types:
- Contact
optional: true
description: 'Optional. Message is a shared contact, information about the contact'
-
name: dice
types:
- Dice
optional: true
description: 'Optional. Message is a dice with random value'
-
name: game
types:
- Game
optional: true
description: 'Optional. Message is a game, information about the game. More about games »'
-
name: poll
types:
- Poll
optional: true
description: 'Optional. Message is a native poll, information about the poll'
-
name: venue
types:
- Venue
optional: true
description: 'Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set'
-
name: location
types:
- Location
optional: true
description: 'Optional. Message is a shared location, information about the location'
-
name: new_chat_members
types:
- Array<User>
optional: true
description: 'Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)'
-
name: left_chat_member
types:
- User
optional: true
description: 'Optional. A member was removed from the group, information about them (this member may be the bot itself)'
-
name: new_chat_title
types:
- string
optional: true
description: 'Optional. A chat title was changed to this value'
-
name: new_chat_photo
types:
- Array<PhotoSize>
optional: true
description: 'Optional. A chat photo was change to this value'
-
name: delete_chat_photo
types:
- bool
optional: true
description: 'Optional. Service message: the chat photo was deleted'
default: true
-
name: group_chat_created
types:
- bool
optional: true
description: 'Optional. Service message: the group has been created'
default: true
-
name: supergroup_chat_created
types:
- bool
optional: true
description: "Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup."
default: true
-
name: channel_chat_created
types:
- bool
optional: true
description: "Optional. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel."
default: true
-
name: message_auto_delete_timer_changed
types:
- MessageAutoDeleteTimerChanged
optional: true
description: 'Optional. Service message: auto-delete timer settings changed in the chat'
-
name: migrate_to_chat_id
types:
- int
optional: true
description: 'Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.'
-
name: migrate_from_chat_id
types:
- int
optional: true
description: 'Optional. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.'
-
name: pinned_message
types:
- Message
optional: true
description: 'Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.'
-
name: invoice
types:
- Invoice
optional: true
description: 'Optional. Message is an invoice for a payment, information about the invoice. More about payments »'
-
name: successful_payment
types:
- SuccessfulPayment
optional: true
description: 'Optional. Message is a service message about a successful payment, information about the payment. More about payments »'
-
name: connected_website
types:
- string
optional: true
description: 'Optional. The domain name of the website on which the user has logged in. More about Telegram Login »'
-
name: passport_data
types:
- PassportData
optional: true
description: 'Optional. Telegram Passport data'
-
name: proximity_alert_triggered
types:
- ProximityAlertTriggered
optional: true
description: "Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location."
-
name: voice_chat_scheduled
types:
- VoiceChatScheduled
optional: true
description: 'Optional. Service message: voice chat scheduled'
-
name: voice_chat_started
types:
- VoiceChatStarted
optional: true
description: 'Optional. Service message: voice chat started'
-
name: voice_chat_ended
types:
- VoiceChatEnded
optional: true
description: 'Optional. Service message: voice chat ended'
-
name: voice_chat_participants_invited
types:
- VoiceChatParticipantsInvited
optional: true
description: 'Optional. Service message: new participants invited to a voice chat'
-
name: reply_markup
types:
- InlineKeyboardMarkup
optional: true
description: 'Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.'
extended_by: { }
-
name: MessageId
description: 'This object represents a unique message identifier.'
fields:
-
name: message_id
types:
- int
optional: false
description: 'Unique message identifier'
extended_by: { }
-
name: MessageEntity
description: 'This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.'
fields:
-
name: type
types:
- string
optional: false
description: 'Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” ([email protected]), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames)'
-
name: offset
types:
- int
optional: false
description: 'Offset in UTF-16 code units to the start of the entity'
-
name: length
types:
- int
optional: false
description: 'Length of the entity in UTF-16 code units'
-
name: url
types:
- string
optional: true
description: 'Optional. For “text_link” only, url that will be opened after user taps on the text'
-
name: user
types:
- User
optional: true
description: 'Optional. For “text_mention” only, the mentioned user'
-
name: language
types:
- string
optional: true
description: 'Optional. For “pre” only, the programming language of the entity text'
extended_by: { }
-
name: PhotoSize
description: 'This object represents one size of a photo or a file / sticker thumbnail.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Identifier for this file, which can be used to download or reuse the file'
-
name: file_unique_id
types:
- string
optional: false
description: "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file."
-
name: width
types:
- int
optional: false
description: 'Photo width'
-
name: height
types:
- int
optional: false
description: 'Photo height'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size in bytes'
extended_by: { }
-
name: Animation
description: 'This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Identifier for this file, which can be used to download or reuse the file'
-
name: file_unique_id
types:
- string
optional: false
description: "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file."
-
name: width
types:
- int
optional: false
description: 'Video width as defined by sender'
-
name: height
types:
- int
optional: false
description: 'Video height as defined by sender'
-
name: duration
types:
- int
optional: false
description: 'Duration of the video in seconds as defined by sender'
-
name: thumb
types:
- PhotoSize
optional: true
description: 'Optional. Animation thumbnail as defined by sender'
-
name: file_name
types:
- string
optional: true
description: 'Optional. Original animation filename as defined by sender'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size in bytes'
extended_by: { }
-
name: Audio
description: 'This object represents an audio file to be treated as music by the Telegram clients.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Identifier for this file, which can be used to download or reuse the file'
-
name: file_unique_id
types:
- string
optional: false
description: "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file."
-
name: duration
types:
- int
optional: false
description: 'Duration of the audio in seconds as defined by sender'
-
name: performer
types:
- string
optional: true
description: 'Optional. Performer of the audio as defined by sender or by audio tags'
-
name: title
types:
- string
optional: true
description: 'Optional. Title of the audio as defined by sender or by audio tags'
-
name: file_name
types:
- string
optional: true
description: 'Optional. Original filename as defined by sender'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size in bytes'
-
name: thumb
types:
- PhotoSize
optional: true
description: 'Optional. Thumbnail of the album cover to which the music file belongs'
extended_by: { }
-
name: Document
description: 'This object represents a general file (as opposed to photos, voice messages and audio files).'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Identifier for this file, which can be used to download or reuse the file'
-
name: file_unique_id
types:
- string
optional: false
description: "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file."
-
name: thumb
types:
- PhotoSize
optional: true
description: 'Optional. Document thumbnail as defined by sender'
-
name: file_name
types:
- string
optional: true
description: 'Optional. Original filename as defined by sender'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size in bytes'
extended_by: { }
-
name: Video
description: 'This object represents a video file.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Identifier for this file, which can be used to download or reuse the file'
-
name: file_unique_id
types:
- string
optional: false
description: "Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file."
-
name: width
types:
- int
optional: false
description: 'Video width as defined by sender'
-
name: height
types:
- int
optional: false
description: 'Video height as defined by sender'
-
name: duration
types:
- int
optional: false
description: 'Duration of the video in seconds as defined by sender'
-
name: thumb
types:
- PhotoSize
optional: true
description: 'Optional. Video thumbnail'
-
name: file_name
types:
- string
optional: true
description: 'Optional. Original filename as defined by sender'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. Mime type of a file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size in bytes'