-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.json
20892 lines (20892 loc) · 674 KB
/
types.json
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
{
"boolFalse": {
"doc": "Constructor may be interpreted as a **boolean**`false` value.",
"parameters": {}
},
"boolTrue": {
"doc": "The constructor can be interpreted as a **boolean**`true` value.",
"parameters": {}
},
"true": {
"doc": "See [predefined identifiers](https://core.telegram.org/mtproto/TL-formal#predefined-identifiers).",
"parameters": {}
},
"vector": {
"doc": "A universal vector constructor.",
"parameters": {}
},
"error": {
"doc": "Error.",
"parameters": {
"code": {
"type": "int",
"doc": "Error code"
},
"text": {
"type": "string",
"doc": "Message"
}
}
},
"null": {
"doc": "Corresponds to an arbitrary empty object.",
"parameters": {}
},
"inputPeerEmpty": {
"doc": "An empty constructor, no user or chat is defined.",
"parameters": {}
},
"inputPeerSelf": {
"doc": "Defines the current user.",
"parameters": {}
},
"inputPeerChat": {
"doc": "Defines a chat for further interaction.",
"parameters": {
"chat_id": {
"type": "long",
"doc": "Chat identifier"
}
}
},
"inputPeerUser": {
"doc": "Defines a user for further interaction.",
"parameters": {
"user_id": {
"type": "long",
"doc": "User identifier"
},
"access_hash": {
"type": "long",
"doc": "**access\\_hash** value from the [user](https://core.telegram.org/constructor/user) constructor"
}
}
},
"inputPeerChannel": {
"doc": "Defines a channel for further interaction.",
"parameters": {
"channel_id": {
"type": "long",
"doc": "Channel identifier"
},
"access_hash": {
"type": "long",
"doc": "**access\\_hash** value from the [channel](https://core.telegram.org/constructor/channel) constructor"
}
}
},
"inputPeerUserFromMessage": {
"doc": "Defines a [min](https://core.telegram.org/api/min) user that was seen in a certain message of a certain chat.",
"parameters": {
"peer": {
"type": "InputPeer",
"doc": "The chat where the user was seen"
},
"msg_id": {
"type": "int",
"doc": "The message ID"
},
"user_id": {
"type": "long",
"doc": "The identifier of the user that was seen"
}
}
},
"inputPeerChannelFromMessage": {
"doc": "Defines a [min](https://core.telegram.org/api/min) channel that was seen in a certain message of a certain chat.",
"parameters": {
"peer": {
"type": "InputPeer",
"doc": "The chat where the channel's message was seen"
},
"msg_id": {
"type": "int",
"doc": "The message ID"
},
"channel_id": {
"type": "long",
"doc": "The identifier of the channel that was seen"
}
}
},
"inputUserEmpty": {
"doc": "Empty constructor, does not define a user.",
"parameters": {}
},
"inputUserSelf": {
"doc": "Defines the current user.",
"parameters": {}
},
"inputUser": {
"doc": "Defines a user for further interaction.",
"parameters": {
"user_id": {
"type": "long",
"doc": "User identifier"
},
"access_hash": {
"type": "long",
"doc": "**access\\_hash** value from the [user](https://core.telegram.org/constructor/user) constructor"
}
}
},
"inputUserFromMessage": {
"doc": "Defines a [min](https://core.telegram.org/api/min) user that was seen in a certain message of a certain chat.",
"parameters": {
"peer": {
"type": "InputPeer",
"doc": "The chat where the user was seen"
},
"msg_id": {
"type": "int",
"doc": "The message ID"
},
"user_id": {
"type": "long",
"doc": "The identifier of the user that was seen"
}
}
},
"inputPhoneContact": {
"doc": "Phone contact.",
"parameters": {
"client_id": {
"type": "long",
"doc": "An arbitrary 64-bit integer: it should be set, for example, to an incremental number when using [contacts.importContacts](https://core.telegram.org/method/contacts.importContacts), in order to retry importing only the contacts that weren't imported successfully, according to the client\\_ids returned in [contacts.importedContacts](https://core.telegram.org/constructor/contacts.importedContacts).`retry_contacts`."
},
"phone": {
"type": "string",
"doc": "Phone number"
},
"first_name": {
"type": "string",
"doc": "Contact's first name"
},
"last_name": {
"type": "string",
"doc": "Contact's last name"
}
}
},
"inputFile": {
"doc": "Defines a file saved in parts using the method [upload.saveFilePart](https://core.telegram.org/method/upload.saveFilePart).",
"parameters": {
"id": {
"type": "long",
"doc": "Random file identifier created by the client"
},
"parts": {
"type": "int",
"doc": "Number of parts saved"
},
"name": {
"type": "string",
"doc": "Full name of the file"
},
"md5_checksum": {
"type": "string",
"doc": "In case the file's [md5-hash](https://en.wikipedia.org/wiki/MD5#MD5_hashes) was passed, contents of the file will be checked prior to use"
}
}
},
"inputFileBig": {
"doc": "Assigns a big file (over 10 MB in size), saved in part using the method [upload.saveBigFilePart](https://core.telegram.org/method/upload.saveBigFilePart).",
"parameters": {
"id": {
"type": "long",
"doc": "Random file id, created by the client"
},
"parts": {
"type": "int",
"doc": "Number of parts saved"
},
"name": {
"type": "string",
"doc": "Full file name"
}
}
},
"inputMediaEmpty": {
"doc": "Empty media content of a message.",
"parameters": {}
},
"inputMediaUploadedPhoto": {
"doc": "Photo",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"spoiler": {
"type": "flags.2?true",
"doc": "Whether this media should be hidden behind a spoiler warning"
},
"file": {
"type": "InputFile",
"doc": "The [uploaded file](https://core.telegram.org/api/files)"
},
"stickers": {
"type": "flags.0?Vector<InputDocument>",
"doc": "Attached mask stickers"
},
"ttl_seconds": {
"type": "flags.1?int",
"doc": "Time to live in seconds of self-destructing photo"
}
}
},
"inputMediaPhoto": {
"doc": "Forwarded photo",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"spoiler": {
"type": "flags.1?true",
"doc": "Whether this media should be hidden behind a spoiler warning"
},
"id": {
"type": "InputPhoto",
"doc": "Photo to be forwarded"
},
"ttl_seconds": {
"type": "flags.0?int",
"doc": "Time to live in seconds of self-destructing photo"
}
}
},
"inputMediaGeoPoint": {
"doc": "Map.",
"parameters": {
"geo_point": {
"type": "InputGeoPoint",
"doc": "GeoPoint"
}
}
},
"inputMediaContact": {
"doc": "Phone book contact",
"parameters": {
"phone_number": {
"type": "string",
"doc": "Phone number"
},
"first_name": {
"type": "string",
"doc": "Contact's first name"
},
"last_name": {
"type": "string",
"doc": "Contact's last name"
},
"vcard": {
"type": "string",
"doc": "Contact vcard"
}
}
},
"inputMediaUploadedDocument": {
"doc": "New document",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"nosound_video": {
"type": "flags.3?true",
"doc": "Whether the specified document is a video file with no audio tracks (a GIF animation (even as MPEG4), for example)"
},
"force_file": {
"type": "flags.4?true",
"doc": "Force the media file to be uploaded as document"
},
"spoiler": {
"type": "flags.5?true",
"doc": "Whether this media should be hidden behind a spoiler warning"
},
"file": {
"type": "InputFile",
"doc": "The [uploaded file](https://core.telegram.org/api/files)"
},
"thumb": {
"type": "flags.2?InputFile",
"doc": "Thumbnail of the document, uploaded as for the file"
},
"mime_type": {
"type": "string",
"doc": "MIME type of document"
},
"attributes": {
"type": "Vector<DocumentAttribute>",
"doc": "Attributes that specify the type of the document (video, audio, voice, sticker, etc.)"
},
"stickers": {
"type": "flags.0?Vector<InputDocument>",
"doc": "Attached stickers"
},
"ttl_seconds": {
"type": "flags.1?int",
"doc": "Time to live in seconds of self-destructing document"
}
}
},
"inputMediaDocument": {
"doc": "Forwarded document",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"spoiler": {
"type": "flags.2?true",
"doc": "Whether this media should be hidden behind a spoiler warning"
},
"id": {
"type": "InputDocument",
"doc": "The document to be forwarded."
},
"ttl_seconds": {
"type": "flags.0?int",
"doc": "Time to live of self-destructing document"
},
"query": {
"type": "flags.1?string",
"doc": "Text query or emoji that was used by the user to find this sticker or GIF: used to improve search result relevance."
}
}
},
"inputMediaVenue": {
"doc": "Can be used to send a venue geolocation.",
"parameters": {
"geo_point": {
"type": "InputGeoPoint",
"doc": "Geolocation"
},
"title": {
"type": "string",
"doc": "Venue name"
},
"address": {
"type": "string",
"doc": "Physical address of the venue"
},
"provider": {
"type": "string",
"doc": "Venue provider: currently only \"foursquare\" and \"gplaces\" (Google Places) need to be supported"
},
"venue_id": {
"type": "string",
"doc": "Venue ID in the provider's database"
},
"venue_type": {
"type": "string",
"doc": "Venue type in the provider's database"
}
}
},
"inputMediaPhotoExternal": {
"doc": "New photo that will be uploaded by the server using the specified URL",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"spoiler": {
"type": "flags.1?true",
"doc": "Whether this media should be hidden behind a spoiler warning"
},
"url": {
"type": "string",
"doc": "URL of the photo"
},
"ttl_seconds": {
"type": "flags.0?int",
"doc": "Self-destruct time to live of photo"
}
}
},
"inputMediaDocumentExternal": {
"doc": "Document that will be downloaded by the telegram servers",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"spoiler": {
"type": "flags.1?true",
"doc": "Whether this media should be hidden behind a spoiler warning"
},
"url": {
"type": "string",
"doc": "URL of the document"
},
"ttl_seconds": {
"type": "flags.0?int",
"doc": "Self-destruct time to live of document"
}
}
},
"inputMediaGame": {
"doc": "A game",
"parameters": {
"id": {
"type": "InputGame",
"doc": "The game to forward"
}
}
},
"inputMediaInvoice": {
"doc": "Generated invoice of a [bot payment](https://core.telegram.org/bots/payments)",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"title": {
"type": "string",
"doc": "Product name, 1-32 characters"
},
"description": {
"type": "string",
"doc": "Product description, 1-255 characters"
},
"photo": {
"type": "flags.0?InputWebDocument",
"doc": "URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for."
},
"invoice": {
"type": "Invoice",
"doc": "The actual invoice"
},
"payload": {
"type": "bytes",
"doc": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes."
},
"provider": {
"type": "string",
"doc": "Payments provider token, obtained via [Botfather](https://t.me/botfather)"
},
"provider_data": {
"type": "DataJSON",
"doc": "JSON-encoded data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider."
},
"start_param": {
"type": "flags.1?string",
"doc": "Unique [bot deep links start parameter](https://core.telegram.org/api/links#bot-links). If present, forwarded copies of the sent message will have a URL button with a [deep link](https://core.telegram.org/api/links#bot-links) to the bot (instead of a Pay button), with the value used as the start parameter. If absent, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice."
},
"extended_media": {
"type": "flags.2?InputMedia",
"doc": "Extended media"
}
}
},
"inputMediaGeoLive": {
"doc": "[Live geolocation](https://core.telegram.org/api/live-location)",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"stopped": {
"type": "flags.0?true",
"doc": "Whether sending of the geolocation was stopped"
},
"geo_point": {
"type": "InputGeoPoint",
"doc": "Current geolocation"
},
"heading": {
"type": "flags.2?int",
"doc": "For [live locations](https://core.telegram.org/api/live-location), a direction in which the location moves, in degrees; 1-360."
},
"period": {
"type": "flags.1?int",
"doc": "Validity period of the current location"
},
"proximity_notification_radius": {
"type": "flags.3?int",
"doc": "For [live locations](https://core.telegram.org/api/live-location), a maximum distance to another chat member for proximity alerts, in meters (0-100000)"
}
}
},
"inputMediaPoll": {
"doc": "A poll",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"poll": {
"type": "Poll",
"doc": "The poll to send"
},
"correct_answers": {
"type": "flags.0?Vector<bytes>",
"doc": "Correct answer IDs (for quiz polls)"
},
"solution": {
"type": "flags.1?string",
"doc": "Explanation of quiz solution"
},
"solution_entities": {
"type": "flags.1?Vector<MessageEntity>",
"doc": "[Message entities for styled text](https://core.telegram.org/api/entities)"
}
}
},
"inputMediaDice": {
"doc": "Send a [dice-based animated sticker](https://core.telegram.org/api/dice)",
"parameters": {
"emoticon": {
"type": "string",
"doc": "The emoji, for now ,  and  are supported"
}
}
},
"inputMediaStory": {
"doc": "Forwarded story",
"parameters": {
"peer": {
"type": "InputPeer",
"doc": "Peer where the story was posted"
},
"id": {
"type": "int",
"doc": "Story ID"
}
}
},
"inputMediaWebPage": {
"doc": "Specifies options that will be used to generate the link preview for the caption, or even a standalone link preview without an attached message.",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"force_large_media": {
"type": "flags.0?true",
"doc": "If set, specifies that a large media preview should be used."
},
"force_small_media": {
"type": "flags.1?true",
"doc": "If set, specifies that a small media preview should be used."
},
"optional": {
"type": "flags.2?true",
"doc": "If **not** set, a `WEBPAGE_NOT_FOUND` RPC error will be emitted if a webpage preview cannot be generated for the specified `url`; otherwise, no error will be emitted (unless the provided message is also empty, in which case a `MESSAGE_EMPTY` will be emitted, instead)."
},
"url": {
"type": "string",
"doc": "The URL to use for the link preview."
}
}
},
"inputChatPhotoEmpty": {
"doc": "Empty constructor, remove group photo.",
"parameters": {}
},
"inputChatUploadedPhoto": {
"doc": "New photo to be set as group profile photo.",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"file": {
"type": "flags.0?InputFile",
"doc": "File saved in parts using the method [upload.saveFilePart](https://core.telegram.org/method/upload.saveFilePart)"
},
"video": {
"type": "flags.1?InputFile",
"doc": "Square video for animated profile picture"
},
"video_start_ts": {
"type": "flags.2?double",
"doc": "Floating point UNIX timestamp in seconds, indicating the frame of the video/sticker that should be used as static preview; can only be used if `video` or `video_emoji_markup` is set."
},
"video_emoji_markup": {
"type": "flags.3?VideoSize",
"doc": "Animated sticker profile picture, must contain either a [videoSizeEmojiMarkup](https://core.telegram.org/constructor/videoSizeEmojiMarkup) or a [videoSizeStickerMarkup](https://core.telegram.org/constructor/videoSizeStickerMarkup) constructor."
}
}
},
"inputChatPhoto": {
"doc": "Existing photo to be set as a chat profile photo.",
"parameters": {
"id": {
"type": "InputPhoto",
"doc": "Existing photo"
}
}
},
"inputGeoPointEmpty": {
"doc": "Empty GeoPoint constructor.",
"parameters": {}
},
"inputGeoPoint": {
"doc": "Defines a GeoPoint by its coordinates.",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"lat": {
"type": "double",
"doc": "Latitude"
},
"long": {
"type": "double",
"doc": "Longitude"
},
"accuracy_radius": {
"type": "flags.0?int",
"doc": "The estimated horizontal accuracy of the location, in meters; as defined by the sender."
}
}
},
"inputPhotoEmpty": {
"doc": "Empty constructor.",
"parameters": {}
},
"inputPhoto": {
"doc": "Defines a photo for further interaction.",
"parameters": {
"id": {
"type": "long",
"doc": "Photo identifier"
},
"access_hash": {
"type": "long",
"doc": "**access\\_hash** value from the [photo](https://core.telegram.org/constructor/photo) constructor"
},
"file_reference": {
"type": "bytes",
"doc": "[File reference](https://core.telegram.org/api/file_reference)"
}
}
},
"inputFileLocation": {
"doc": "DEPRECATED location of a photo",
"parameters": {
"volume_id": {
"type": "long",
"doc": "Server volume"
},
"local_id": {
"type": "int",
"doc": "File identifier"
},
"secret": {
"type": "long",
"doc": "Check sum to access the file"
},
"file_reference": {
"type": "bytes",
"doc": "[File reference](https://core.telegram.org/api/file_reference)"
}
}
},
"inputEncryptedFileLocation": {
"doc": "Location of encrypted secret chat file.",
"parameters": {
"id": {
"type": "long",
"doc": "File ID, **id** parameter value from [encryptedFile](https://core.telegram.org/constructor/encryptedFile)"
},
"access_hash": {
"type": "long",
"doc": "Checksum, **access\\_hash** parameter value from [encryptedFile](https://core.telegram.org/constructor/encryptedFile)"
}
}
},
"inputDocumentFileLocation": {
"doc": "Document location (video, voice, audio, basically every type except photo)",
"parameters": {
"id": {
"type": "long",
"doc": "Document ID"
},
"access_hash": {
"type": "long",
"doc": "**access\\_hash** parameter from the [document](https://core.telegram.org/constructor/document) constructor"
},
"file_reference": {
"type": "bytes",
"doc": "[File reference](https://core.telegram.org/api/file_reference)"
},
"thumb_size": {
"type": "string",
"doc": "Thumbnail size to download the thumbnail"
}
}
},
"inputSecureFileLocation": {
"doc": "Location of encrypted telegram [passport](https://core.telegram.org/passport) file.",
"parameters": {
"id": {
"type": "long",
"doc": "File ID, **id** parameter value from [secureFile](https://core.telegram.org/constructor/secureFile)"
},
"access_hash": {
"type": "long",
"doc": "Checksum, **access\\_hash** parameter value from [secureFile](https://core.telegram.org/constructor/secureFile)"
}
}
},
"inputTakeoutFileLocation": {
"doc": "Used to download a JSON file that will contain all personal data related to features that do not have a specialized [takeout method](https://core.telegram.org/api/takeout) yet, see [here »](https://core.telegram.org/api/takeout) for more info on the takeout API.",
"parameters": {}
},
"inputPhotoFileLocation": {
"doc": "Use this object to download a photo with [upload.getFile](https://core.telegram.org/method/upload.getFile) method",
"parameters": {
"id": {
"type": "long",
"doc": "Photo ID, obtained from the [photo](https://core.telegram.org/constructor/photo) object"
},
"access_hash": {
"type": "long",
"doc": "Photo's access hash, obtained from the [photo](https://core.telegram.org/constructor/photo) object"
},
"file_reference": {
"type": "bytes",
"doc": "[File reference](https://core.telegram.org/api/file_reference)"
},
"thumb_size": {
"type": "string",
"doc": "The [PhotoSize](https://core.telegram.org/type/PhotoSize) to download: must be set to the `type` field of the desired PhotoSize object of the [photo](https://core.telegram.org/constructor/photo)"
}
}
},
"inputPhotoLegacyFileLocation": {
"doc": "DEPRECATED legacy photo file location",
"parameters": {
"id": {
"type": "long",
"doc": "Photo ID"
},
"access_hash": {
"type": "long",
"doc": "Access hash"
},
"file_reference": {
"type": "bytes",
"doc": "File reference"
},
"volume_id": {
"type": "long",
"doc": "Volume ID"
},
"local_id": {
"type": "int",
"doc": "Local ID"
},
"secret": {
"type": "long",
"doc": "Secret"
}
}
},
"inputPeerPhotoFileLocation": {
"doc": "Location of profile photo of channel/group/supergroup/user",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"big": {
"type": "flags.0?true",
"doc": "Whether to download the high-quality version of the picture"
},
"peer": {
"type": "InputPeer",
"doc": "The peer whose profile picture should be downloaded"
},
"photo_id": {
"type": "long",
"doc": "Photo ID"
}
}
},
"inputStickerSetThumb": {
"doc": "Location of stickerset thumbnail (see [files](https://core.telegram.org/api/files))",
"parameters": {
"stickerset": {
"type": "InputStickerSet",
"doc": "Sticker set"
},
"thumb_version": {
"type": "int",
"doc": "Thumbnail version"
}
}
},
"inputGroupCallStream": {
"doc": "Chunk of a livestream",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"call": {
"type": "InputGroupCall",
"doc": "Livestream info"
},
"time_ms": {
"type": "long",
"doc": "Timestamp in milliseconds"
},
"scale": {
"type": "int",
"doc": "Specifies the duration of the video segment to fetch in milliseconds, by bitshifting `1000` to the right `scale` times: `duration_ms := 1000 >> scale`"
},
"video_channel": {
"type": "flags.0?int",
"doc": "Selected video channel"
},
"video_quality": {
"type": "flags.0?int",
"doc": "Selected video quality (0 = lowest, 1 = medium, 2 = best)"
}
}
},
"peerUser": {
"doc": "Chat partner",
"parameters": {
"user_id": {
"type": "long",
"doc": "User identifier"
}
}
},
"peerChat": {
"doc": "Group.",
"parameters": {
"chat_id": {
"type": "long",
"doc": "Group identifier"
}
}
},
"peerChannel": {
"doc": "Channel/supergroup",
"parameters": {
"channel_id": {
"type": "long",
"doc": "Channel ID"
}
}
},
"storage.fileUnknown": {
"doc": "Unknown type.",
"parameters": {}
},
"storage.filePartial": {
"doc": "Part of a bigger file.",
"parameters": {}
},
"storage.fileJpeg": {
"doc": "JPEG image. MIME type: `image/jpeg`.",
"parameters": {}
},
"storage.fileGif": {
"doc": "GIF image. MIME type: `image/gif`.",
"parameters": {}
},
"storage.filePng": {
"doc": "PNG image. MIME type: `image/png`.",
"parameters": {}
},
"storage.filePdf": {
"doc": "PDF document image. MIME type: `application/pdf`.",
"parameters": {}
},
"storage.fileMp3": {
"doc": "Mp3 audio. MIME type: `audio/mpeg`.",
"parameters": {}
},
"storage.fileMov": {
"doc": "Quicktime video. MIME type: `video/quicktime`.",
"parameters": {}
},
"storage.fileMp4": {
"doc": "MPEG-4 video. MIME type: `video/mp4`.",
"parameters": {}
},
"storage.fileWebp": {
"doc": "WEBP image. MIME type: `image/webp`.",
"parameters": {}
},
"userEmpty": {
"doc": "Empty constructor, non-existent user.",
"parameters": {
"id": {
"type": "long",
"doc": "User identifier or `0`"
}
}
},
"user": {
"doc": "Indicates info about a certain user",
"parameters": {
"flags": {
"type": "#",
"doc": "Flags, see [TL conditional fields](https://core.telegram.org/mtproto/TL-combinators#conditional-fields)"
},
"self": {
"type": "flags.10?true",
"doc": "Whether this user indicates the currently logged in user"
},
"contact": {
"type": "flags.11?true",
"doc": "Whether this user is a contact"
},
"mutual_contact": {
"type": "flags.12?true",
"doc": "Whether this user is a mutual contact"
},
"deleted": {
"type": "flags.13?true",
"doc": "Whether the account of this user was deleted"
},
"bot": {
"type": "flags.14?true",
"doc": "Is this user a bot?"
},
"bot_chat_history": {
"type": "flags.15?true",
"doc": "Can the bot see all messages in groups?"
},
"bot_nochats": {
"type": "flags.16?true",
"doc": "Can the bot be added to groups?"
},
"verified": {
"type": "flags.17?true",
"doc": "Whether this user is verified"
},
"restricted": {
"type": "flags.18?true",
"doc": "Access to this user must be restricted for the reason specified in `restriction_reason`"
},
"min": {
"type": "flags.20?true",
"doc": "See [min](https://core.telegram.org/api/min)"
},
"bot_inline_geo": {
"type": "flags.21?true",
"doc": "Whether the bot can request our geolocation in inline mode"
},
"support": {
"type": "flags.23?true",
"doc": "Whether this is an official support user"
},
"scam": {
"type": "flags.24?true",
"doc": "This may be a scam user"
},
"apply_min_photo": {
"type": "flags.25?true",
"doc": "If set, the profile picture for this user should be refetched"
},
"fake": {
"type": "flags.26?true",
"doc": "If set, this user was reported by many users as a fake or scam user: be careful when interacting with them."
},
"bot_attach_menu": {
"type": "flags.27?true",
"doc": "Whether this bot offers an [attachment menu web app](https://core.telegram.org/api/bots/attach)"
},