-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathdocs.json
More file actions
20178 lines (20178 loc) · 871 KB
/
docs.json
File metadata and controls
20178 lines (20178 loc) · 871 KB
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
{
"constructor": {
"AccountDaysTTL": {
"desc": "Time to live in days of the current account",
"params": {
"days": "This account will self-destruct in the specified number of days"
}
},
"AttachMenuBot": {
"desc": "Represents a bot mini app that can be launched from the attachment/side menu \u00bb",
"params": {
"bot_id": "Bot ID",
"flags": "Flags, see TL conditional fields",
"has_settings": "Deprecated flag, can be ignored.",
"icons": "List of platform-specific static icons and animations to use for the attachment menu button",
"inactive": "If set, before launching the mini app the client should ask the user to add the mini app to the attachment/side menu, and only if the user accepts, after invoking messages.toggleBotInAttachMenu the app should be opened.",
"peer_types": "List of dialog types where this attachment menu entry should be shown",
"request_write_access": "Whether the bot would like to send messages to the user.",
"short_name": "Attachment menu item name",
"show_in_attach_menu": "Whether, when installed, an attachment menu entry should be shown for the Mini App.",
"show_in_side_menu": "Whether, when installed, an entry in the main view side menu should be shown for the Mini App.",
"side_menu_disclaimer_needed": "If inactive if set and the user hasn't previously accepted the third-party mini apps Terms of Service for this bot, when showing the mini app installation prompt, an additional mandatory checkbox to accept the mini apps TOS and a disclaimer indicating that this Mini App is not affiliated to Telegram should be shown."
}
},
"AttachMenuBotIcon": {
"desc": "Represents an attachment menu icon for bot mini apps \u00bb",
"params": {
"colors": "Attachment menu icon colors.",
"flags": "Flags, see TL conditional fields",
"icon": "The actual icon file.",
"name": "One of the following values: note that animated icons must be played when the user clicks on the button, activating the bot mini app. default_static - Default attachment menu icon in SVG format placeholder_static - Default placeholder for opened Web Apps in SVG format ios_static - Attachment menu icon in SVG format for the official iOS app ios_animated - Animated attachment menu icon in TGS format for the official iOS app android_animated - Animated attachment menu icon in TGS format for the official Android app macos_animated - Animated attachment menu icon in TGS format for the official native Mac OS app ios_side_menu_static - Side menu icon in PNG format for the official iOS app android_side_menu_static - Side menu icon in SVG format for the official android app macos_side_menu_static - Side menu icon in PNG format for the official native Mac OS app"
}
},
"AttachMenuBotIconColor": {
"desc": "Represents an attachment menu icon color for bot mini apps \u00bb",
"params": {
"color": "Color in RGB24 format",
"name": "One of the following values: light_icon - Color of the attachment menu icon (light mode) light_text - Color of the attachment menu label, once selected (light mode) dark_icon - Color of the attachment menu icon (dark mode) dark_text - Color of the attachment menu label, once selected (dark mode)"
}
},
"AttachMenuBots": {
"desc": "Represents a list of bot mini apps that can be launched from the attachment menu \u00bb",
"params": {
"bots": "List of bot mini apps that can be launched from the attachment menu \u00bb",
"hash": "Hash used for caching, for more info click here",
"users": "Info about related users/bots"
}
},
"AttachMenuBotsBot": {
"desc": "Represents a bot mini app that can be launched from the attachment menu \u00bb",
"params": {
"bot": "Represents a bot mini app that can be launched from the attachment menu \u00bb",
"users": "Info about related users and bots"
}
},
"AttachMenuBotsNotModified": {
"desc": "The list of bot mini apps hasn't changed",
"params": {}
},
"AttachMenuPeerTypeBotPM": {
"desc": "The bot attachment menu entry is available in private chats with other bots (excluding the bot that offers the current attachment menu)",
"params": {}
},
"AttachMenuPeerTypeBroadcast": {
"desc": "The bot attachment menu entry is available in channels",
"params": {}
},
"AttachMenuPeerTypeChat": {
"desc": "The bot attachment menu entry is available in groups and supergroups",
"params": {}
},
"AttachMenuPeerTypePM": {
"desc": "The bot attachment menu entry is available in private chats with other users (not bots)",
"params": {}
},
"AttachMenuPeerTypeSameBotPM": {
"desc": "The bot attachment menu entry is available in the chat with the bot that offers it",
"params": {}
},
"AuctionBidLevel": {
"desc": "{schema}",
"params": {
"amount": "",
"date": "",
"pos": ""
}
},
"Authorization": {
"desc": "Logged-in session",
"params": {
"api_id": "API ID",
"app_name": "App name",
"app_version": "App version",
"call_requests_disabled": "Whether this session will accept phone calls",
"country": "Country determined from IP",
"current": "Whether this is the current session",
"date_active": "When was the session last active",
"date_created": "When was the session created",
"device_model": "Device model",
"encrypted_requests_disabled": "Whether this session will accept encrypted chats",
"flags": "Flags, see TL conditional fields",
"hash": "Identifier",
"ip": "Last known IP",
"official_app": "Whether the session is from an official app",
"password_pending": "Whether the session is still waiting for a 2FA password",
"platform": "Platform",
"region": "Region determined from IP",
"system_version": "System version",
"unconfirmed": "Whether the session is unconfirmed, see here \u00bb for more info."
}
},
"AutoDownloadSettings": {
"desc": "Autodownload settings",
"params": {
"audio_preload_next": "Whether to preload the next audio track when you're listening to music",
"disabled": "Disable automatic media downloads?",
"file_size_max": "Maximum size of other files to preload",
"flags": "Flags, see TL conditional fields",
"large_queue_active_operations_max": "A limit, specifying the maximum number of files that should be downloaded in parallel from the same DC, for files bigger than 20MB.",
"phonecalls_less_data": "Whether to enable data saving mode in phone calls",
"photo_size_max": "Maximum size of photos to preload",
"small_queue_active_operations_max": "A limit, specifying the maximum number of files that should be downloaded in parallel from the same DC, for files smaller than 20MB.",
"stories_preload": "Whether to preload stories; in particular, the first documentAttributeVideo.preload_prefix_size bytes of story videos should be preloaded.",
"video_preload_large": "Whether to preload the first seconds of videos larger than the specified limit",
"video_size_max": "Maximum size of videos to preload",
"video_upload_maxbitrate": "Maximum suggested bitrate for uploading videos"
}
},
"AutoSaveException": {
"desc": "Peer-specific media autosave settings",
"params": {
"peer": "The peer",
"settings": "Media autosave settings"
}
},
"AutoSaveSettings": {
"desc": "Media autosave settings",
"params": {
"flags": "Flags, see TL conditional fields",
"photos": "Whether photos should be autosaved to the gallery.",
"video_max_size": "If set, specifies a size limit for autosavable videos",
"videos": "Whether videos should be autosaved to the gallery."
}
},
"AvailableEffect": {
"desc": "Represents a message effect \u00bb.",
"params": {
"effect_animation_id": "If set, contains the actual animated effect (TGS format \u00bb). If not set, the animated effect must be set equal to the premium animated sticker effect associated to the animated sticker specified in effect_sticker_id (always different from the preview animation, fetched thanks to the videoSize of type f as specified here \u00bb).",
"effect_sticker_id": "Contains the preview animation (TGS format \u00bb), used for the effect selection menu.",
"emoticon": "Emoji corresponding to the effect, to be used as icon for the effect if static_icon_id is not set.",
"flags": "Flags, see TL conditional fields",
"id": "Unique effect ID.",
"premium_required": "Whether a Premium subscription is required to use this effect.",
"static_icon_id": "ID of the document containing the static icon (WEBP) of the effect."
}
},
"AvailableReaction": {
"desc": "Animations associated with a message reaction",
"params": {
"activate_animation": "The animated sticker to show when the reaction is chosen and activated",
"appear_animation": "The animated sticker to show when the user opens the reaction dropdown",
"around_animation": "The animation that plays around the button when you press an existing reaction (played together with center_icon).",
"center_icon": "The animation of the emoji inside the button when you press an existing reaction (played together with around_animation).",
"effect_animation": "The background effect (still an animated sticker) to play under the activate_animation, when the reaction is chosen and activated",
"flags": "Flags, see TL conditional fields",
"inactive": "If not set, the reaction can be added to new messages and enabled in chats.",
"premium": "Whether this reaction can only be used by Telegram Premium users",
"reaction": "Reaction emoji",
"select_animation": "The animated sticker to show when the user hovers over the reaction",
"static_icon": "Static icon for the reaction",
"title": "Reaction description"
}
},
"BankCardOpenUrl": {
"desc": "Credit card info URL provided by the bank",
"params": {
"name": "Bank name",
"url": "Info URL"
}
},
"BaseThemeArctic": {
"desc": "Arctic theme",
"params": {}
},
"BaseThemeClassic": {
"desc": "Classic theme",
"params": {}
},
"BaseThemeDay": {
"desc": "Day theme",
"params": {}
},
"BaseThemeNight": {
"desc": "Night theme",
"params": {}
},
"BaseThemeTinted": {
"desc": "Tinted theme",
"params": {}
},
"Birthday": {
"desc": "Birthday information for a user.",
"params": {
"day": "Birth day",
"flags": "Flags, see TL conditional fields",
"month": "Birth month",
"year": "(Optional) birth year."
}
},
"Boost": {
"desc": "Info about one or more boosts applied by a specific user.",
"params": {
"date": "When was the boost applied",
"expires": "When does the boost expire",
"flags": "Flags, see TL conditional fields",
"gift": "Whether this boost was applied because the channel/supergroup directly gifted a subscription to the user.",
"giveaway": "Whether this boost was applied because the user was chosen in a giveaway started by the channel/supergroup.",
"giveaway_msg_id": "The message ID of the giveaway",
"id": "Unique ID for this set of boosts.",
"multiplier": "If set, this boost counts as multiplier boosts, otherwise it counts as a single boost.",
"stars": "Number of Telegram Stars distributed among the winners of the giveaway.",
"unclaimed": "If set, the user hasn't yet invoked payments.applyGiftCode to claim a subscription gifted directly or in a giveaway by the channel.",
"used_gift_slug": "The created Telegram Premium gift code, only set if either gift or giveaway are set AND it is either a gift code for the currently logged in user or if it was already claimed.",
"user_id": "ID of the user that applied the boost."
}
},
"BotApp": {
"desc": "Contains information about a direct link Mini App.",
"params": {
"access_hash": "bot mini app access hash",
"description": "bot mini app description.",
"document": "bot mini app animation.",
"flags": "Flags, see TL conditional fields",
"hash": "Hash to pass to messages.getBotApp, to avoid refetching bot app info if it hasn't changed.",
"id": "bot mini app ID",
"photo": "bot mini app photo.",
"short_name": "bot mini app short name, used to generate Direct Mini App deep links.",
"title": "bot mini app title."
}
},
"BotAppNotModified": {
"desc": "Bot app info hasn't changed.",
"params": {}
},
"BotAppSettings": {
"desc": "Mini app \u00bb settings",
"params": {
"background_color": "Default light mode background color",
"background_dark_color": "Default dark mode background color",
"flags": "Flags, see TL conditional fields",
"header_color": "Default light mode header color",
"header_dark_color": "Default dark mode header color",
"placeholder_path": "SVG placeholder logo, compressed using the same format used for vector thumbnails \u00bb."
}
},
"BotBusinessConnection": {
"desc": "Contains info about a bot business connection.",
"params": {
"connection_id": "Business connection ID, used to identify messages coming from the connection and to reply to them as specified here \u00bb.",
"date": "When was the connection created.",
"dc_id": "ID of the datacenter where to send queries wrapped in a invokeWithBusinessConnection as specified here \u00bb.",
"disabled": "Whether this business connection is currently disabled",
"flags": "Flags, see TL conditional fields",
"rights": "Business bot rights.",
"user_id": "ID of the user that the bot is connected to via this connection."
}
},
"BotCommand": {
"desc": "Describes a bot command that can be used in a chat",
"params": {
"command": "/command name",
"description": "Description of the command"
}
},
"BotCommandScopeChatAdmins": {
"desc": "The specified bot commands will be valid only for chat administrators, in all groups and supergroups.",
"params": {}
},
"BotCommandScopeChats": {
"desc": "The specified bot commands will be valid in all groups and supergroups.",
"params": {}
},
"BotCommandScopeDefault": {
"desc": "The commands will be valid in all dialogs",
"params": {}
},
"BotCommandScopePeer": {
"desc": "The specified bot commands will be valid only in a specific dialog.",
"params": {
"peer": "The dialog"
}
},
"BotCommandScopePeerAdmins": {
"desc": "The specified bot commands will be valid for all admins of the specified group or supergroup.",
"params": {
"peer": "The chat"
}
},
"BotCommandScopePeerUser": {
"desc": "The specified bot commands will be valid only for a specific user in the specified group or supergroup.",
"params": {
"peer": "The chat",
"user_id": "The user"
}
},
"BotCommandScopeUsers": {
"desc": "The specified bot commands will only be valid in all private chats with users.",
"params": {}
},
"BotInfo": {
"desc": "Info about bots (available bot commands, etc)",
"params": {
"app_settings": "Mini app \u00bb settings",
"commands": "Bot commands that can be used in the chat",
"description": "Description of the bot",
"description_document": "Description animation in MPEG4 format",
"description_photo": "Description photo",
"flags": "Flags, see TL conditional fields",
"has_preview_medias": "If set, the bot has some preview medias for the configured Main Mini App, see here \u00bb for more info on Main Mini App preview medias.",
"menu_button": "Indicates the action to execute when pressing the in-UI menu button for bots",
"privacy_policy_url": "The HTTP link to the privacy policy of the bot. If not set, then the /privacy command must be used, if supported by the bot (i.e. if it's present in the commands vector). If it isn't supported, then https://telegram.org/privacy-tpa must be opened, instead.",
"user_id": "ID of the bot",
"verifier_settings": "This bot can verify peers: this field contains more info about the verification the bot can assign to peers."
}
},
"BotInlineMediaResult": {
"desc": "Media result",
"params": {
"description": "Description",
"document": "If type is document, the document to send",
"flags": "Flags, see TL conditional fields",
"id": "Result ID",
"photo": "If type is photo, the photo to send",
"send_message": "Depending on the type and on the constructor, contains the caption of the media or the content of the message to be sent instead of the media",
"title": "Result title",
"type": "Result type (see bot API docs)"
}
},
"BotInlineMessageMediaAuto": {
"desc": "Send whatever media is attached to the botInlineMediaResult",
"params": {
"entities": "Message entities for styled text",
"flags": "Flags, see TL conditional fields",
"invert_media": "If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.",
"message": "Caption",
"reply_markup": "Inline keyboard"
}
},
"BotInlineMessageMediaContact": {
"desc": "Send a contact",
"params": {
"first_name": "First name",
"flags": "Flags, see TL conditional fields",
"last_name": "Last name",
"phone_number": "Phone number",
"reply_markup": "Inline keyboard",
"vcard": "VCard info"
}
},
"BotInlineMessageMediaGeo": {
"desc": "Send a geolocation",
"params": {
"flags": "Flags, see TL conditional fields",
"geo": "Geolocation",
"heading": "For live locations, a direction in which the location moves, in degrees; 1-360.",
"period": "Validity period",
"proximity_notification_radius": "For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000).",
"reply_markup": "Inline keyboard"
}
},
"BotInlineMessageMediaInvoice": {
"desc": "Send an invoice",
"params": {
"currency": "Three-letter ISO 4217 currency code, or XTR for Telegram Stars.",
"description": "Product description, 1-255 characters",
"flags": "Flags, see TL conditional fields",
"photo": "Product photo",
"reply_markup": "Inline keyboard",
"shipping_address_requested": "Set this flag if you require the user's shipping address to complete the order",
"test": "Test invoice",
"title": "Product name, 1-32 characters",
"total_amount": "Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies)."
}
},
"BotInlineMessageMediaVenue": {
"desc": "Send a venue",
"params": {
"address": "Address",
"flags": "Flags, see TL conditional fields",
"geo": "Geolocation of venue",
"provider": "Venue provider: currently only \"foursquare\" and \"gplaces\" (Google Places) need to be supported",
"reply_markup": "Inline keyboard",
"title": "Venue name",
"venue_id": "Venue ID in the provider's database",
"venue_type": "Venue type in the provider's database"
}
},
"BotInlineMessageMediaWebPage": {
"desc": "Specifies options that must be used to generate the link preview for the message, or even a standalone link preview without an attached message.",
"params": {
"entities": "Message entities for styled text",
"flags": "Flags, see TL conditional fields",
"force_large_media": "If set, specifies that a large media preview should be used.",
"force_small_media": "If set, specifies that a small media preview should be used.",
"invert_media": "If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.",
"manual": "If set, indicates that the URL used for the webpage preview was specified manually using inputMediaWebPage, and may not be related to any of the URLs specified in the message.",
"message": "The message, can be empty.",
"reply_markup": "Reply markup for sending bot buttons",
"safe": "If set, the link can be opened directly without user confirmation.",
"url": "The URL to use for the link preview."
}
},
"BotInlineMessageText": {
"desc": "Send a simple text message",
"params": {
"entities": "Message entities for styled text",
"flags": "Flags, see TL conditional fields",
"invert_media": "If set, any eventual webpage preview will be shown on top of the message instead of at the bottom.",
"message": "The message",
"no_webpage": "Disable webpage preview",
"reply_markup": "Inline keyboard"
}
},
"BotInlineResult": {
"desc": "Generic result",
"params": {
"content": "Content of the result",
"description": "Result description",
"flags": "Flags, see TL conditional fields",
"id": "Result ID",
"send_message": "Message to send",
"thumb": "Thumbnail for the result",
"title": "Result title",
"type": "Result type (see bot API docs)",
"url": "URL of article or webpage"
}
},
"BotMenuButton": {
"desc": "Bot menu button that opens a web app when clicked.",
"params": {
"text": "Title to be displayed on the menu button instead of 'Menu'",
"url": "URL of a web app to open when the user clicks on the button"
}
},
"BotMenuButtonCommands": {
"desc": "Bot menu button that opens the bot command list when clicked.",
"params": {}
},
"BotMenuButtonDefault": {
"desc": "Placeholder bot menu button never returned to users: see the docs for more info.",
"params": {}
},
"BotPreviewMedia": {
"desc": "Represents a Main Mini App preview media, see here \u00bb for more info.",
"params": {
"date": "When was this media last updated.",
"media": "The actual photo/video."
}
},
"BotVerification": {
"desc": "Describes a bot verification icon \u00bb.",
"params": {
"bot_id": "ID of the bot that verified this peer",
"description": "Verification description",
"icon": "Verification icon"
}
},
"BotVerifierSettings": {
"desc": "Info about the current verifier bot \u00bb.",
"params": {
"can_modify_custom_description": "Indicates whether the bot is allowed to set a custom description field for individual verified peers, different from the custom_description provided here.",
"company": "The name of the organization that provides the verification",
"custom_description": "An optional default description for the verification",
"flags": "Flags, see TL conditional fields",
"icon": "Verification icon"
}
},
"BusinessAwayMessage": {
"desc": "Describes a Telegram Business away message, automatically sent to users writing to us when we're offline, during closing hours, while we're on vacation, or in some other custom time period when we cannot immediately answer to the user.",
"params": {
"flags": "Flags, see TL conditional fields",
"offline_only": "If set, the messages will not be sent if the account was online in the last 10 minutes.",
"recipients": "Allowed recipients for the away messages.",
"schedule": "Specifies when should the away messages be sent.",
"shortcut_id": "ID of a quick reply shorcut, containing the away messages to send, see here \u00bb for more info."
}
},
"BusinessAwayMessageScheduleAlways": {
"desc": "Always send Telegram Business away messages to users writing to us in private.",
"params": {}
},
"BusinessAwayMessageScheduleCustom": {
"desc": "Send Telegram Business away messages to users writing to us in private in the specified time span.",
"params": {
"end_date": "End date (UNIX timestamp).",
"start_date": "Start date (UNIX timestamp)."
}
},
"BusinessAwayMessageScheduleOutsideWorkHours": {
"desc": "Send Telegram Business away messages to users writing to us in private outside of the configured Telegram Business working hours.",
"params": {}
},
"BusinessBotRecipients": {
"desc": "Specifies the private chats that a connected business bot \u00bb may receive messages and interact with.",
"params": {
"contacts": "Selects all private chats with contacts.",
"exclude_selected": "If set, then all private chats except the ones selected by existing_chats, new_chats, contacts, non_contacts and users are chosen. Note that if this flag is set, any values passed in exclude_users will be merged and moved into users by the server, thus exclude_users will always be empty.",
"exclude_users": "Identifiers of private chats that are always excluded.",
"existing_chats": "Selects all existing private chats.",
"flags": "Flags, see TL conditional fields",
"new_chats": "Selects all new private chats.",
"non_contacts": "Selects all private chats with non-contacts.",
"users": "Explicitly selected private chats."
}
},
"BusinessBotRights": {
"desc": "Business bot rights.",
"params": {
"change_gift_settings": "Whether the bot can change the privacy settings pertaining to gifts for the business account.",
"delete_received_messages": "Whether the bot can delete received private messages in managed chats.",
"delete_sent_messages": "Whether the bot can delete messages sent by the bot.",
"edit_bio": "Whether the bot can edit the bio of the business account.",
"edit_name": "Whether the bot can edit the first and last name of the business account.",
"edit_profile_photo": "Whether the bot can edit the profile photo of the business account.",
"edit_username": "Whether the bot can edit the username of the business account.",
"flags": "Flags, see TL conditional fields",
"manage_stories": "Whether the bot can post, edit and delete stories on behalf of the business account.",
"read_messages": "Whether the bot can mark incoming private messages as read.",
"reply": "Whether the bot can send and edit messages in private chats that had incoming messages in the last 24 hours.",
"sell_gifts": "Whether the bot can convert regular gifts owned by the business account to Telegram Stars.",
"transfer_and_upgrade_gifts": "Whether the bot can transfer and upgrade gifts owned by the business account.",
"transfer_stars": "Whether the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts.",
"view_gifts": "Whether the bot can view gifts and the amount of Telegram Stars owned by the business account."
}
},
"BusinessChatLink": {
"desc": "Contains info about a business chat deep link \u00bb created by the current account.",
"params": {
"entities": "Message entities for styled text",
"flags": "Flags, see TL conditional fields",
"link": "Business chat deep link.",
"message": "Message to pre-fill in the message input field.",
"title": "Human-readable name of the link, to simplify management in the UI (only visible to the creator of the link).",
"views": "Number of times the link was resolved (clicked/scanned/etc...)."
}
},
"BusinessGreetingMessage": {
"desc": "Describes a Telegram Business greeting, automatically sent to new users writing to us in private for the first time, or after a certain inactivity period.",
"params": {
"no_activity_days": "The number of days after which a private chat will be considered as inactive; currently, must be one of 7, 14, 21, or 28.",
"recipients": "Allowed recipients for the greeting messages.",
"shortcut_id": "ID of a quick reply shorcut, containing the greeting messages to send, see here \u00bb for more info."
}
},
"BusinessIntro": {
"desc": "Telegram Business introduction \u00bb.",
"params": {
"description": "Profile introduction (max intro_description_length_limit \u00bb UTF-8 characters).",
"flags": "Flags, see TL conditional fields",
"sticker": "Optional introduction sticker.",
"title": "Title of the introduction message (max intro_title_length_limit \u00bb UTF-8 characters)."
}
},
"BusinessLocation": {
"desc": "Represents the location of a Telegram Business \u00bb.",
"params": {
"address": "Textual description of the address (mandatory).",
"flags": "Flags, see TL conditional fields",
"geo_point": "Geographical coordinates (optional)."
}
},
"BusinessRecipients": {
"desc": "Specifies the chats that can receive Telegram Business away \u00bb and greeting \u00bb messages.",
"params": {
"contacts": "All private chats with contacts.",
"exclude_selected": "If set, inverts the selection.",
"existing_chats": "All existing private chats.",
"flags": "Flags, see TL conditional fields",
"new_chats": "All new private chats.",
"non_contacts": "All private chats with non-contacts.",
"users": "Only private chats with the specified users."
}
},
"BusinessWeeklyOpen": {
"desc": "A time interval, indicating the opening hours of a business.",
"params": {
"end_minute": "End minute in minutes of the week, 1 to 8*24*60 inclusively (8 and not 7 because this allows to specify intervals that, for example, start on Sunday 21:00 and end on Monday 04:00 (6*24*60+21*60 to 7*24*60+4*60) without passing an invalid end_minute < start_minute). See here \u00bb for more info.",
"start_minute": "Start minute in minutes of the week, 0 to 7*24*60 inclusively."
}
},
"BusinessWorkHours": {
"desc": "Specifies a set of Telegram Business opening hours.",
"params": {
"flags": "Flags, see TL conditional fields",
"open_now": "Ignored if set while invoking account.updateBusinessWorkHours, only returned by the server in userFull.business_work_hours, indicating whether the business is currently open according to the current time and the values in weekly_open and timezone.",
"timezone_id": "An ID of one of the timezones returned by help.getTimezonesList. The timezone ID is contained timezone.id, a human-readable, localized name of the timezone is available in timezone.name and the timezone.utc_offset field contains the UTC offset in seconds, which may be displayed in hh:mm format by the client together with the human-readable name (i.e. $name UTC -01:00).",
"weekly_open": "A list of time intervals (max 28) represented by businessWeeklyOpen \u00bb, indicating the opening hours of their business."
}
},
"CdnConfig": {
"desc": "Configuration for CDN file downloads.",
"params": {
"public_keys": "Vector of public keys to use only during handshakes to CDN DCs."
}
},
"CdnPublicKey": {
"desc": "Public key to use only during handshakes to CDN DCs.",
"params": {
"dc_id": "CDN DC ID",
"public_key": "RSA public key"
}
},
"Channel": {
"desc": "Channel/supergroup info",
"params": {
"access_hash": "Access hash, see here \u00bb for more info",
"admin_rights": "Admin rights of the user in this channel (see rights)",
"autotranslation": "If set, autotranslation was enabled for all users by the admin of the channel, as specified here \u00bb.",
"banned_rights": "Banned rights of the user in this channel (see rights)",
"bot_verification_icon": "Describes a bot verification icon \u00bb.",
"broadcast": "Is this a channel?",
"broadcast_messages_allowed": "If set, this channel has an associated monoforum \u00bb, and its ID is specified in the linked_monoforum_id flag.",
"call_active": "Whether a group call or livestream is currently active",
"call_not_empty": "Whether there's anyone in the group call or livestream",
"color": "The channel's accent color.",
"creator": "Whether the current user is the creator of this channel",
"date": "Date when the user joined the supergroup/channel, or if the user isn't a member, its creation date",
"default_banned_rights": "Default chat rights (see rights)",
"emoji_status": "Emoji status",
"fake": "If set, this supergroup/channel was reported by many users as a fake or scam: be careful when interacting with it. Changes to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"flags": "Flags, see TL conditional fields",
"flags2": "Flags, see TL conditional fields",
"forum": "Whether this supergroup is a forum. Changes to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"forum_tabs": "If set, enables the tabbed forum UI \u00bb.",
"gigagroup": "Whether this supergroup is a gigagroupChanges to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"has_geo": "Whether this chanel has a geoposition",
"has_link": "Whether this channel has a linked discussion group \u00bb (or this supergroup is a channel's discussion group). The actual ID of the linked channel/supergroup is contained in channelFull.linked_chat_id. Changes to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"id": "ID of the channel, see here \u00bb for more info and the available ID range.",
"join_request": "Whether a user's join request will have to be approved by administrators, toggle using channels.toggleJoinToSendChanges to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"join_to_send": "Whether a user needs to join the supergroup before they can send messages: can be false only for discussion groups \u00bb, toggle using channels.toggleJoinToSendChanges to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"left": "Whether the current user has left or is not a member of this channel",
"level": "Boost level. Changes to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"linked_monoforum_id": "For channels with associated monoforums, the monoforum ID. For Monoforums, the ID of the associated channel.",
"megagroup": "Is this a supergroup? Changes to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"min": "See min",
"monoforum": "If set, this is a monoforum \u00bb, and the ID of the associated channel is specified in the linked_monoforum_id.",
"noforwards": "Whether this channel or group is protected, thus does not allow forwarding messages from it",
"participants_count": "Participant count",
"photo": "Profile photo",
"profile_color": "The channel's profile color.",
"restricted": "Whether viewing/writing in this channel for a reason (see restriction_reason)",
"restriction_reason": "Contains the reason why access to this channel must be restricted. Changes to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"scam": "This channel/supergroup is probably a scam Changes to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"send_paid_messages_stars": "If set, this supergroup or monoforum has enabled paid messages \u00bb, we might need to pay the specified amount of Stars to send messages to it, depending on the configured exceptions: check channelFull.send_paid_messages_stars to see if the currently logged in user actually has to pay or not, see here \u00bb for the full flow (only set for the monoforum, not the associated channel).",
"signature_profiles": "If set, messages sent by admins to this channel will link to the admin's profile (just like with groups).",
"signatures": "Whether signatures are enabled (channels)",
"slowmode_enabled": "Whether slow mode is enabled for groups to prevent flood in chat. Changes to this flag should invalidate the local channelFull cache for this channel/supergroup ID, see here \u00bb for more info.",
"stories_hidden": "Whether we have hidden all stories posted by this channel \u00bb.",
"stories_hidden_min": "If set, indicates that the stories_hidden flag was not populated, and its value must cannot be relied on; use the previously cached value, or re-fetch the constructor using channels.getChannels to obtain the latest value of the stories_hidden flag.",
"stories_max_id": "ID of the maximum read story.",
"stories_unavailable": "No stories from the channel are visible.",
"subscription_until_date": "Expiration date of the Telegram Star subscription \u00bb the current user has bought to gain access to this channel.",
"title": "Title",
"username": "Main active username.",
"usernames": "Additional usernames",
"verified": "Is this channel verified by telegram?"
}
},
"ChannelAdminLogEvent": {
"desc": "Admin log event",
"params": {
"action": "Action",
"date": "Date",
"id": "Event ID",
"user_id": "User ID"
}
},
"ChannelAdminLogEventActionChangeAbout": {
"desc": "The description was changed",
"params": {
"new_value": "New description",
"prev_value": "Previous description"
}
},
"ChannelAdminLogEventActionChangeAvailableReactions": {
"desc": "The set of allowed message reactions \u00bb for this channel has changed",
"params": {
"new_value": "New allowed reaction emojis",
"prev_value": "Previously allowed reaction emojis"
}
},
"ChannelAdminLogEventActionChangeEmojiStatus": {
"desc": "The emoji status was changed",
"params": {
"new_value": "New emoji status",
"prev_value": "Previous emoji status"
}
},
"ChannelAdminLogEventActionChangeEmojiStickerSet": {
"desc": "The supergroup's custom emoji stickerset was changed.",
"params": {
"new_stickerset": "New value",
"prev_stickerset": "Old value"
}
},
"ChannelAdminLogEventActionChangeHistoryTTL": {
"desc": "The Time-To-Live of messages in this chat was changed",
"params": {
"new_value": "New value",
"prev_value": "Previous value"
}
},
"ChannelAdminLogEventActionChangeLinkedChat": {
"desc": "The linked chat was changed",
"params": {
"new_value": "New linked chat",
"prev_value": "Previous linked chat"
}
},
"ChannelAdminLogEventActionChangeLocation": {
"desc": "The geogroup location was changed",
"params": {
"new_value": "New location",
"prev_value": "Previous location"
}
},
"ChannelAdminLogEventActionChangePeerColor": {
"desc": "The message accent color was changed",
"params": {
"new_value": "New accent palette",
"prev_value": "Previous accent palette"
}
},
"ChannelAdminLogEventActionChangePhoto": {
"desc": "The channel/supergroup's picture was changed",
"params": {
"new_photo": "New picture",
"prev_photo": "Previous picture"
}
},
"ChannelAdminLogEventActionChangeProfilePeerColor": {
"desc": "The profile accent color was changed",
"params": {
"new_value": "New accent palette",
"prev_value": "Previous accent palette"
}
},
"ChannelAdminLogEventActionChangeStickerSet": {
"desc": "The supergroup's stickerset was changed",
"params": {
"new_stickerset": "New stickerset",
"prev_stickerset": "Previous stickerset"
}
},
"ChannelAdminLogEventActionChangeTitle": {
"desc": "Channel/supergroup title was changed",
"params": {
"new_value": "New title",
"prev_value": "Previous title"
}
},
"ChannelAdminLogEventActionChangeUsername": {
"desc": "Channel/supergroup username was changed",
"params": {
"new_value": "New username",
"prev_value": "Old username"
}
},
"ChannelAdminLogEventActionChangeUsernames": {
"desc": "The list of usernames associated with the channel was changed",
"params": {
"new_value": "New set of usernames",
"prev_value": "Previous set of usernames"
}
},
"ChannelAdminLogEventActionChangeWallpaper": {
"desc": "The wallpaper was changed",
"params": {
"new_value": "New wallpaper",
"prev_value": "Previous wallpaper"
}
},
"ChannelAdminLogEventActionCreateTopic": {
"desc": "A forum topic was created",
"params": {
"topic": "The forum topic that was created"
}
},
"ChannelAdminLogEventActionDefaultBannedRights": {
"desc": "The default banned rights were modified",
"params": {
"new_banned_rights": "New global banned rights.",
"prev_banned_rights": "Previous global banned rights"
}
},
"ChannelAdminLogEventActionDeleteMessage": {
"desc": "A message was deleted",
"params": {
"message": "The message that was deleted"
}
},
"ChannelAdminLogEventActionDeleteTopic": {
"desc": "A forum topic was deleted",
"params": {
"topic": "The forum topic that was deleted"
}
},
"ChannelAdminLogEventActionDiscardGroupCall": {
"desc": "A group call was terminated",
"params": {
"call": "The group call that was terminated"
}
},
"ChannelAdminLogEventActionEditMessage": {
"desc": "A message was edited",
"params": {
"new_message": "New message",
"prev_message": "Old message"
}
},
"ChannelAdminLogEventActionEditTopic": {
"desc": "A forum topic was edited",
"params": {
"new_topic": "New topic information",
"prev_topic": "Previous topic information"
}
},
"ChannelAdminLogEventActionExportedInviteDelete": {
"desc": "A chat invite was deleted",
"params": {
"invite": "The deleted chat invite"
}
},
"ChannelAdminLogEventActionExportedInviteEdit": {
"desc": "A chat invite was edited",
"params": {
"new_invite": "New chat invite information",
"prev_invite": "Previous chat invite information"
}
},
"ChannelAdminLogEventActionExportedInviteRevoke": {
"desc": "A specific invite link was revoked",
"params": {
"invite": "The invite link that was revoked"
}
},
"ChannelAdminLogEventActionParticipantEditRank": {
"desc": "{schema}",
"params": {
"new_rank": "",
"prev_rank": "",
"user_id": ""
}
},
"ChannelAdminLogEventActionParticipantInvite": {
"desc": "A user was invited to the group",
"params": {
"participant": "The user that was invited"
}
},
"ChannelAdminLogEventActionParticipantJoin": {
"desc": "A user has joined the group (in the case of big groups, info of the user that has joined isn't shown)",
"params": {}
},
"ChannelAdminLogEventActionParticipantJoinByInvite": {
"desc": "A user joined the supergroup/channel using a specific invite link",
"params": {
"flags": "Flags, see TL conditional fields",
"invite": "The invite link used to join the supergroup/channel",
"via_chatlist": "The participant joined by importing a chat folder deep link \u00bb."
}
},
"ChannelAdminLogEventActionParticipantJoinByRequest": {
"desc": "A new member was accepted to the chat by an admin",
"params": {
"approved_by": "ID of the admin that approved the invite",
"invite": "The invite link that was used to join the chat"
}
},
"ChannelAdminLogEventActionParticipantLeave": {
"desc": "A user left the channel/supergroup (in the case of big groups, info of the user that has joined isn't shown)",
"params": {}
},
"ChannelAdminLogEventActionParticipantMute": {
"desc": "A group call participant was muted",
"params": {
"participant": "The participant that was muted"
}
},
"ChannelAdminLogEventActionParticipantSubExtend": {
"desc": "A paid subscriber has extended their Telegram Star subscription \u00bb.",
"params": {
"new_participant": "The subscriber that extended the subscription.",
"prev_participant": "Same as new_participant."
}
},
"ChannelAdminLogEventActionParticipantToggleAdmin": {
"desc": "The admin rights of a user were changed",
"params": {
"new_participant": "New admin rights",
"prev_participant": "Previous admin rights"
}
},
"ChannelAdminLogEventActionParticipantToggleBan": {
"desc": "The banned rights of a user were changed",
"params": {
"new_participant": "New banned rights of user",
"prev_participant": "Old banned rights of user"
}
},
"ChannelAdminLogEventActionParticipantUnmute": {
"desc": "A group call participant was unmuted",
"params": {
"participant": "The participant that was unmuted"
}
},
"ChannelAdminLogEventActionParticipantVolume": {
"desc": "channelAdminLogEvent.user_id has set the volume of participant.peer to participant.volume",
"params": {
"participant": "The participant whose volume was changed"
}
},
"ChannelAdminLogEventActionPinTopic": {
"desc": "A forum topic was pinned or unpinned",
"params": {
"flags": "Flags, see TL conditional fields",
"new_topic": "New topic information",
"prev_topic": "Previous topic information"
}
},
"ChannelAdminLogEventActionSendMessage": {
"desc": "A message was posted in a channel",
"params": {
"message": "The message that was sent"
}
},
"ChannelAdminLogEventActionStartGroupCall": {
"desc": "A group call was started",
"params": {
"call": "Group call"
}
},
"ChannelAdminLogEventActionStopPoll": {
"desc": "A poll was stopped",
"params": {
"message": "The poll that was stopped"
}
},
"ChannelAdminLogEventActionToggleAntiSpam": {
"desc": "Native antispam functionality was enabled or disabled.",
"params": {
"new_value": "Whether antispam functionality was enabled or disabled."
}
},
"ChannelAdminLogEventActionToggleAutotranslation": {
"desc": "Channel autotranslation was toggled \u00bb.",
"params": {
"new_value": "New value of the toggle"
}
},
"ChannelAdminLogEventActionToggleForum": {
"desc": "Forum functionality was enabled or disabled.",
"params": {
"new_value": "Whether forum functionality was enabled or disabled."
}
},
"ChannelAdminLogEventActionToggleGroupCallSetting": {
"desc": "Group call settings were changed",
"params": {
"join_muted": "Whether all users are muted by default upon joining"
}
},
"ChannelAdminLogEventActionToggleInvites": {
"desc": "Invites were enabled/disabled",
"params": {
"new_value": "New value"
}
},
"ChannelAdminLogEventActionToggleNoForwards": {
"desc": "Forwards were enabled or disabled",
"params": {
"new_value": "Old value"
}
},
"ChannelAdminLogEventActionTogglePreHistoryHidden": {
"desc": "The hidden prehistory setting was changed",
"params": {
"new_value": "New value"
}
},
"ChannelAdminLogEventActionToggleSignatureProfiles": {
"desc": "Channel signature profiles were enabled/disabled.",
"params": {
"new_value": "New value"
}
},
"ChannelAdminLogEventActionToggleSignatures": {
"desc": "Channel signatures were enabled/disabled",
"params": {
"new_value": "New value"