Use this method to send a native poll. On success, the sent is returned.
643 matches
60 actions
Telegram
60 actions
- post_addStickerToSetPOSTv1.0.0
- post_answerInlineQueryPOSTv1.0.0
- post_answerPreCheckoutQueryPOSTv1.0.0
- post_closePOSTv1.0.0
- post_copyMessagePOSTv1.0.0
- post_createNewStickerSetPOSTv1.0.0
- post_editMessageCaptionPOSTv1.0.0
- post_editMessageLiveLocationPOSTv1.0.0
- post_editMessageMediaPOSTv1.0.0
- post_editMessageReplyMarkupPOSTv1.0.0
- post_editMessageTextPOSTv1.0.0
- post_forwardMessagePOSTv1.0.0
- post_getChatPOSTv1.0.0
- post_getChatAdministratorsPOSTv1.0.0
- post_getChatMemberPOSTv1.0.0
- post_getChatMembersCountPOSTv1.0.0
- post_getFilePOSTv1.0.0
- post_getGameHighScoresPOSTv1.0.0
- post_getMePOSTv1.0.0
- post_getMyCommandsPOSTv1.0.0
- post_getStickerSetPOSTv1.0.0
- post_getUpdatesPOSTv1.0.0
- post_getUserProfilePhotosPOSTv1.0.0
- post_kickChatMemberPOSTv1.0.0
- post_leaveChatPOSTv1.0.0
- post_logOutPOSTv1.0.0
- post_pinChatMessagePOSTv1.0.0
- post_promoteChatMemberPOSTv1.0.0
- post_restrictChatMemberPOSTv1.0.0
- post_sendAnimationPOSTv1.0.0
- post_sendAudioPOSTv1.0.0
- post_sendChatActionPOSTv1.0.0
- post_sendContactPOSTv1.0.0
- post_sendDicePOSTv1.0.0
- post_sendDocumentPOSTv1.0.0
- post_sendGamePOSTv1.0.0
- post_sendInvoicePOSTv1.0.0
- post_sendLocationPOSTv1.0.0
- post_sendMediaGroupPOSTv1.0.0
- post_sendMessagePOSTv1.0.0
- post_sendPhotoPOSTv1.0.0
- post_sendPollPOSTv1.0.0
- post_sendStickerPOSTv1.0.0
- post_sendVenuePOSTv1.0.0
- post_sendVideoPOSTv1.0.0
- post_sendVideoNotePOSTv1.0.0
- post_sendVoicePOSTv1.0.0
- post_setChatAdministratorCustomTitlePOSTv1.0.0
- post_setChatDescriptionPOSTv1.0.0
- post_setChatPermissionsPOSTv1.0.0
- post_setChatPhotoPOSTv1.0.0
- post_setChatStickerSetPOSTv1.0.0
- post_setChatTitlePOSTv1.0.0
- post_setGameScorePOSTv1.0.0
- post_setMyCommandsPOSTv1.0.0
- post_setPassportDataErrorsPOSTv1.0.0
- post_setStickerPositionInSetPOSTv1.0.0
- post_setStickerSetThumbPOSTv1.0.0
- post_stopMessageLiveLocationPOSTv1.0.0
- post_stopPollPOSTv1.0.0
Communication/Telegram
post_sendPoll
v1.0.0Input
- 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
{
"type": "object",
"required": [
"chat_id",
"options",
"question"
],
"properties": {
"allow_sending_without_reply": {
"type": "boolean",
"description": "Pass *True*, if the message should be sent even if the specified replied-to message is not found"
},
"allows_multiple_answers": {
"type": "boolean",
"description": "True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to *False*"
},
"chat_id": {
"description": "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)",
"type": "object"
},
"close_date": {
"type": "integer",
"description": "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with *open\\_period*."
},
"correct_option_id": {
"type": "integer",
"description": "0-based identifier of the correct answer option, required for polls in quiz mode"
},
"disable_notification": {
"type": "boolean",
"description": "Sends the message [silently](https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound."
},
"explanation": {
"type": "string",
"description": "Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing"
},
"explanation_entities": {
"type": "array",
"description": "List of special entities that appear in the poll explanation, which can be specified instead of *parse\\_mode*",
"items": {
"type": "object",
"description": "This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.",
"required": [
"type",
"offset",
"length"
],
"properties": {
"language": {
"type": "string",
"description": "*Optional*. For “pre” only, the programming language of the entity text"
},
"length": {
"type": "integer",
"description": "Length of the entity in UTF-16 code units"
},
"offset": {
"type": "integer",
"description": "Offset in UTF-16 code units to the start of the entity"
},
"type": {
"type": "string",
"description": "Type of the entity. 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), “code” (monowidth string), “pre” (monowidth block), “text\\_link” (for clickable text URLs), “text\\_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions))",
"enum": [
"mention",
"hashtag",
"cashtag",
"bot_command",
"url",
"email",
"phone_number",
"bold",
"italic",
"underline",
"strikethrough",
"code",
"pre",
"text_link",
"text_mention"
]
},
"url": {
"type": "string",
"description": "*Optional*. For “text\\_link” only, url that will be opened after user taps on the text"
},
"user": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"id",
"is_bot",
"first_name"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
}
}
}
},
"explanation_parse_mode": {
"type": "string",
"description": "Mode for parsing entities in the explanation. See [formatting options](https://core.telegram.org/bots/api/#formatting-options) for more details."
},
"is_anonymous": {
"type": "boolean",
"description": "True, if the poll needs to be anonymous, defaults to *True*"
},
"is_closed": {
"type": "boolean",
"description": "Pass *True*, if the poll needs to be immediately closed. This can be useful for poll preview."
},
"open_period": {
"type": "integer",
"description": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close\\_date*."
},
"options": {
"type": "array",
"description": "A JSON-serialized list of answer options, 2-10 strings 1-100 characters each",
"items": {
"type": "string"
}
},
"question": {
"type": "string",
"description": "Poll question, 1-300 characters"
},
"reply_markup": {
"description": "Additional interface options. A JSON-serialized object for an [inline keyboard](https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating), [custom reply keyboard](https://core.telegram.org/bots#keyboards), instructions to remove reply keyboard or to force a reply from the user.",
"type": "object"
},
"reply_to_message_id": {
"type": "integer",
"description": "If the message is a reply, ID of the original message"
},
"type": {
"type": "string",
"description": "Poll type, “quiz” or “regular”, defaults to “regular”"
}
}
}Output
- 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
- 1001
- 1002
- 1003
- 1004
- 1005
- 1006
- 1007
- 1008
- 1009
- 1010
- 1011
- 1012
- 1013
- 1014
- 1015
- 1016
- 1017
- 1018
- 1019
- 1020
- 1021
- 1022
- 1023
- 1024
- 1025
- 1026
- 1027
- 1028
- 1029
- 1030
- 1031
- 1032
- 1033
- 1034
- 1035
- 1036
- 1037
- 1038
- 1039
- 1040
- 1041
- 1042
- 1043
- 1044
- 1045
- 1046
- 1047
- 1048
- 1049
- 1050
- 1051
- 1052
- 1053
- 1054
- 1055
- 1056
- 1057
- 1058
- 1059
- 1060
- 1061
- 1062
- 1063
- 1064
- 1065
- 1066
- 1067
- 1068
- 1069
- 1070
- 1071
- 1072
- 1073
- 1074
- 1075
- 1076
- 1077
- 1078
- 1079
- 1080
- 1081
- 1082
- 1083
- 1084
- 1085
- 1086
- 1087
- 1088
- 1089
- 1090
- 1091
- 1092
- 1093
- 1094
- 1095
- 1096
- 1097
- 1098
- 1099
- 1100
- 1101
- 1102
- 1103
- 1104
- 1105
- 1106
- 1107
- 1108
- 1109
- 1110
- 1111
- 1112
- 1113
- 1114
- 1115
- 1116
- 1117
- 1118
- 1119
- 1120
- 1121
- 1122
- 1123
- 1124
- 1125
- 1126
- 1127
- 1128
- 1129
- 1130
- 1131
- 1132
- 1133
- 1134
- 1135
- 1136
- 1137
- 1138
- 1139
- 1140
- 1141
- 1142
- 1143
- 1144
- 1145
- 1146
- 1147
- 1148
- 1149
- 1150
- 1151
- 1152
- 1153
- 1154
- 1155
- 1156
- 1157
- 1158
- 1159
- 1160
- 1161
- 1162
- 1163
- 1164
- 1165
- 1166
- 1167
- 1168
- 1169
- 1170
- 1171
- 1172
- 1173
- 1174
- 1175
- 1176
- 1177
- 1178
- 1179
- 1180
- 1181
- 1182
- 1183
- 1184
- 1185
- 1186
- 1187
- 1188
- 1189
- 1190
- 1191
- 1192
- 1193
- 1194
- 1195
- 1196
- 1197
- 1198
- 1199
- 1200
- 1201
- 1202
- 1203
- 1204
- 1205
- 1206
- 1207
- 1208
- 1209
- 1210
- 1211
- 1212
- 1213
- 1214
- 1215
- 1216
- 1217
- 1218
- 1219
- 1220
- 1221
- 1222
- 1223
- 1224
- 1225
- 1226
- 1227
- 1228
- 1229
- 1230
- 1231
- 1232
- 1233
- 1234
- 1235
- 1236
- 1237
- 1238
- 1239
- 1240
- 1241
- 1242
- 1243
- 1244
- 1245
- 1246
- 1247
- 1248
- 1249
- 1250
- 1251
- 1252
- 1253
- 1254
- 1255
- 1256
- 1257
- 1258
- 1259
- 1260
- 1261
- 1262
- 1263
- 1264
- 1265
- 1266
- 1267
- 1268
- 1269
- 1270
- 1271
- 1272
- 1273
- 1274
- 1275
- 1276
- 1277
- 1278
- 1279
- 1280
- 1281
- 1282
- 1283
- 1284
- 1285
- 1286
- 1287
- 1288
- 1289
- 1290
- 1291
- 1292
- 1293
- 1294
- 1295
- 1296
- 1297
- 1298
- 1299
- 1300
- 1301
- 1302
- 1303
- 1304
- 1305
- 1306
- 1307
- 1308
- 1309
- 1310
- 1311
- 1312
- 1313
- 1314
- 1315
- 1316
- 1317
- 1318
- 1319
- 1320
- 1321
- 1322
- 1323
- 1324
- 1325
- 1326
- 1327
- 1328
- 1329
- 1330
- 1331
- 1332
- 1333
- 1334
- 1335
- 1336
- 1337
- 1338
- 1339
- 1340
- 1341
- 1342
- 1343
- 1344
- 1345
- 1346
- 1347
- 1348
- 1349
- 1350
- 1351
- 1352
- 1353
- 1354
- 1355
- 1356
- 1357
- 1358
- 1359
- 1360
- 1361
- 1362
- 1363
- 1364
- 1365
- 1366
- 1367
- 1368
- 1369
- 1370
- 1371
- 1372
- 1373
- 1374
- 1375
- 1376
- 1377
- 1378
- 1379
- 1380
- 1381
- 1382
- 1383
- 1384
- 1385
- 1386
- 1387
- 1388
- 1389
- 1390
- 1391
- 1392
- 1393
- 1394
- 1395
- 1396
- 1397
- 1398
- 1399
- 1400
- 1401
- 1402
- 1403
- 1404
- 1405
- 1406
- 1407
- 1408
- 1409
- 1410
- 1411
- 1412
- 1413
- 1414
- 1415
- 1416
- 1417
- 1418
- 1419
- 1420
- 1421
- 1422
- 1423
- 1424
- 1425
- 1426
- 1427
- 1428
- 1429
- 1430
- 1431
- 1432
- 1433
- 1434
- 1435
- 1436
- 1437
- 1438
- 1439
- 1440
- 1441
- 1442
- 1443
- 1444
- 1445
- 1446
- 1447
- 1448
- 1449
- 1450
- 1451
- 1452
- 1453
- 1454
- 1455
- 1456
- 1457
- 1458
- 1459
- 1460
- 1461
- 1462
- 1463
- 1464
- 1465
- 1466
- 1467
- 1468
- 1469
- 1470
- 1471
- 1472
- 1473
- 1474
- 1475
- 1476
- 1477
- 1478
- 1479
- 1480
- 1481
- 1482
- 1483
- 1484
- 1485
- 1486
- 1487
- 1488
- 1489
- 1490
- 1491
- 1492
- 1493
- 1494
- 1495
- 1496
- 1497
- 1498
- 1499
- 1500
- 1501
- 1502
- 1503
- 1504
- 1505
- 1506
- 1507
- 1508
- 1509
- 1510
- 1511
- 1512
- 1513
- 1514
- 1515
- 1516
- 1517
- 1518
- 1519
- 1520
- 1521
- 1522
- 1523
- 1524
- 1525
- 1526
- 1527
- 1528
- 1529
- 1530
- 1531
- 1532
- 1533
- 1534
- 1535
- 1536
- 1537
- 1538
- 1539
- 1540
- 1541
- 1542
- 1543
- 1544
- 1545
- 1546
- 1547
- 1548
- 1549
- 1550
- 1551
- 1552
- 1553
- 1554
- 1555
- 1556
- 1557
- 1558
- 1559
- 1560
- 1561
- 1562
- 1563
- 1564
- 1565
- 1566
- 1567
- 1568
- 1569
- 1570
- 1571
- 1572
- 1573
- 1574
- 1575
- 1576
- 1577
- 1578
- 1579
- 1580
- 1581
- 1582
- 1583
- 1584
- 1585
- 1586
- 1587
- 1588
- 1589
- 1590
- 1591
- 1592
- 1593
- 1594
- 1595
- 1596
- 1597
- 1598
- 1599
- 1600
- 1601
- 1602
- 1603
- 1604
- 1605
- 1606
- 1607
- 1608
- 1609
- 1610
- 1611
- 1612
- 1613
- 1614
- 1615
- 1616
- 1617
- 1618
- 1619
- 1620
- 1621
- 1622
- 1623
- 1624
- 1625
- 1626
- 1627
- 1628
- 1629
- 1630
- 1631
- 1632
- 1633
- 1634
- 1635
- 1636
- 1637
- 1638
- 1639
- 1640
- 1641
- 1642
- 1643
- 1644
- 1645
- 1646
- 1647
- 1648
- 1649
- 1650
- 1651
- 1652
- 1653
- 1654
- 1655
- 1656
- 1657
- 1658
- 1659
- 1660
- 1661
- 1662
- 1663
- 1664
- 1665
- 1666
- 1667
- 1668
- 1669
- 1670
- 1671
- 1672
- 1673
- 1674
- 1675
- 1676
- 1677
- 1678
- 1679
- 1680
- 1681
- 1682
- 1683
- 1684
- 1685
- 1686
- 1687
- 1688
- 1689
- 1690
- 1691
- 1692
- 1693
- 1694
- 1695
- 1696
- 1697
- 1698
- 1699
- 1700
- 1701
- 1702
- 1703
- 1704
- 1705
- 1706
- 1707
- 1708
- 1709
- 1710
- 1711
- 1712
- 1713
- 1714
- 1715
- 1716
- 1717
- 1718
- 1719
- 1720
- 1721
- 1722
- 1723
- 1724
- 1725
- 1726
- 1727
- 1728
- 1729
- 1730
- 1731
- 1732
- 1733
- 1734
- 1735
- 1736
- 1737
- 1738
- 1739
- 1740
- 1741
- 1742
- 1743
- 1744
- 1745
- 1746
- 1747
- 1748
- 1749
- 1750
- 1751
- 1752
- 1753
- 1754
- 1755
- 1756
- 1757
- 1758
- 1759
- 1760
- 1761
- 1762
- 1763
- 1764
- 1765
- 1766
- 1767
- 1768
- 1769
- 1770
- 1771
- 1772
- 1773
- 1774
- 1775
- 1776
- 1777
- 1778
- 1779
- 1780
- 1781
- 1782
- 1783
- 1784
- 1785
- 1786
- 1787
- 1788
- 1789
- 1790
- 1791
- 1792
- 1793
- 1794
- 1795
- 1796
- 1797
- 1798
- 1799
- 1800
- 1801
- 1802
- 1803
- 1804
- 1805
- 1806
- 1807
- 1808
- 1809
- 1810
- 1811
- 1812
- 1813
- 1814
- 1815
- 1816
- 1817
- 1818
- 1819
- 1820
- 1821
- 1822
- 1823
- 1824
- 1825
- 1826
- 1827
- 1828
- 1829
- 1830
- 1831
- 1832
- 1833
- 1834
- 1835
- 1836
- 1837
- 1838
- 1839
- 1840
- 1841
- 1842
- 1843
- 1844
- 1845
- 1846
- 1847
- 1848
- 1849
- 1850
- 1851
- 1852
- 1853
- 1854
- 1855
- 1856
- 1857
- 1858
- 1859
- 1860
- 1861
- 1862
- 1863
- 1864
- 1865
- 1866
- 1867
- 1868
- 1869
- 1870
- 1871
- 1872
- 1873
- 1874
- 1875
- 1876
- 1877
- 1878
- 1879
- 1880
- 1881
- 1882
- 1883
- 1884
- 1885
- 1886
- 1887
- 1888
- 1889
- 1890
- 1891
- 1892
- 1893
- 1894
- 1895
- 1896
- 1897
- 1898
- 1899
- 1900
- 1901
- 1902
- 1903
- 1904
- 1905
- 1906
- 1907
- 1908
- 1909
- 1910
- 1911
- 1912
- 1913
- 1914
- 1915
- 1916
- 1917
- 1918
- 1919
- 1920
- 1921
- 1922
- 1923
- 1924
- 1925
- 1926
- 1927
- 1928
- 1929
- 1930
- 1931
- 1932
- 1933
- 1934
- 1935
- 1936
- 1937
- 1938
- 1939
- 1940
- 1941
- 1942
- 1943
- 1944
- 1945
- 1946
- 1947
- 1948
- 1949
- 1950
- 1951
- 1952
- 1953
- 1954
- 1955
- 1956
- 1957
- 1958
- 1959
- 1960
- 1961
- 1962
- 1963
- 1964
- 1965
- 1966
- 1967
- 1968
- 1969
- 1970
- 1971
- 1972
- 1973
- 1974
- 1975
- 1976
- 1977
- 1978
- 1979
- 1980
- 1981
- 1982
- 1983
- 1984
- 1985
- 1986
- 1987
- 1988
- 1989
- 1990
- 1991
- 1992
- 1993
- 1994
- 1995
- 1996
- 1997
- 1998
- 1999
- 2000
- 2001
- 2002
- 2003
- 2004
- 2005
- 2006
- 2007
- 2008
- 2009
- 2010
- 2011
- 2012
- 2013
- 2014
- 2015
- 2016
- 2017
- 2018
- 2019
- 2020
- 2021
- 2022
- 2023
- 2024
- 2025
- 2026
- 2027
- 2028
- 2029
- 2030
- 2031
- 2032
- 2033
- 2034
- 2035
- 2036
- 2037
- 2038
- 2039
- 2040
- 2041
- 2042
- 2043
- 2044
- 2045
- 2046
- 2047
- 2048
- 2049
- 2050
- 2051
- 2052
- 2053
- 2054
- 2055
- 2056
- 2057
- 2058
- 2059
- 2060
- 2061
- 2062
- 2063
- 2064
- 2065
- 2066
- 2067
- 2068
- 2069
- 2070
- 2071
- 2072
- 2073
- 2074
- 2075
- 2076
- 2077
- 2078
- 2079
- 2080
- 2081
- 2082
- 2083
- 2084
- 2085
- 2086
- 2087
- 2088
- 2089
- 2090
- 2091
- 2092
- 2093
- 2094
- 2095
- 2096
- 2097
- 2098
- 2099
- 2100
- 2101
- 2102
- 2103
- 2104
- 2105
- 2106
- 2107
- 2108
- 2109
- 2110
- 2111
- 2112
- 2113
- 2114
- 2115
- 2116
- 2117
- 2118
- 2119
- 2120
- 2121
- 2122
- 2123
- 2124
- 2125
- 2126
- 2127
- 2128
- 2129
- 2130
- 2131
- 2132
- 2133
- 2134
- 2135
- 2136
- 2137
- 2138
- 2139
- 2140
- 2141
- 2142
- 2143
- 2144
- 2145
- 2146
- 2147
- 2148
- 2149
- 2150
- 2151
- 2152
- 2153
- 2154
- 2155
- 2156
- 2157
- 2158
- 2159
- 2160
- 2161
- 2162
- 2163
- 2164
- 2165
- 2166
- 2167
- 2168
- 2169
- 2170
- 2171
- 2172
- 2173
- 2174
- 2175
- 2176
- 2177
- 2178
- 2179
- 2180
- 2181
- 2182
- 2183
- 2184
- 2185
- 2186
- 2187
- 2188
- 2189
- 2190
- 2191
- 2192
- 2193
- 2194
- 2195
- 2196
- 2197
- 2198
- 2199
- 2200
- 2201
- 2202
- 2203
- 2204
- 2205
- 2206
- 2207
- 2208
- 2209
- 2210
- 2211
- 2212
- 2213
- 2214
- 2215
- 2216
- 2217
- 2218
- 2219
- 2220
- 2221
- 2222
- 2223
- 2224
- 2225
- 2226
- 2227
- 2228
- 2229
- 2230
- 2231
- 2232
- 2233
- 2234
- 2235
- 2236
- 2237
- 2238
- 2239
- 2240
- 2241
- 2242
- 2243
- 2244
- 2245
- 2246
- 2247
- 2248
- 2249
- 2250
- 2251
- 2252
- 2253
- 2254
- 2255
- 2256
- 2257
- 2258
- 2259
- 2260
- 2261
- 2262
- 2263
- 2264
- 2265
- 2266
- 2267
- 2268
- 2269
- 2270
- 2271
- 2272
- 2273
- 2274
- 2275
- 2276
- 2277
- 2278
- 2279
- 2280
- 2281
- 2282
- 2283
- 2284
- 2285
- 2286
- 2287
- 2288
- 2289
- 2290
- 2291
- 2292
- 2293
- 2294
- 2295
- 2296
- 2297
- 2298
- 2299
- 2300
- 2301
- 2302
- 2303
- 2304
- 2305
- 2306
- 2307
- 2308
- 2309
- 2310
- 2311
- 2312
- 2313
- 2314
- 2315
- 2316
- 2317
- 2318
- 2319
- 2320
- 2321
- 2322
- 2323
- 2324
- 2325
- 2326
- 2327
- 2328
- 2329
- 2330
- 2331
- 2332
- 2333
- 2334
- 2335
- 2336
- 2337
- 2338
- 2339
- 2340
- 2341
- 2342
- 2343
- 2344
- 2345
- 2346
- 2347
- 2348
- 2349
- 2350
- 2351
- 2352
- 2353
- 2354
- 2355
- 2356
- 2357
- 2358
- 2359
- 2360
- 2361
- 2362
- 2363
- 2364
- 2365
- 2366
- 2367
- 2368
- 2369
- 2370
- 2371
- 2372
- 2373
- 2374
- 2375
- 2376
- 2377
- 2378
- 2379
- 2380
- 2381
- 2382
- 2383
- 2384
- 2385
- 2386
- 2387
- 2388
- 2389
- 2390
- 2391
- 2392
- 2393
- 2394
- 2395
- 2396
- 2397
- 2398
- 2399
- 2400
- 2401
- 2402
- 2403
- 2404
- 2405
- 2406
- 2407
- 2408
- 2409
- 2410
- 2411
- 2412
- 2413
- 2414
- 2415
- 2416
- 2417
{
"type": "object",
"required": [
"ok",
"result"
],
"properties": {
"ok": {
"type": "boolean"
},
"result": {
"type": "object",
"description": "This object represents a message.",
"required": [
"chat",
"date",
"message_id"
],
"properties": {
"animation": {
"type": "object",
"description": "This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).",
"required": [
"duration",
"file_id",
"file_unique_id",
"height",
"width"
],
"properties": {
"duration": {
"type": "integer",
"description": "Duration of the video in seconds as defined by sender"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_name": {
"type": "string",
"description": "*Optional*. Original animation filename as defined by sender"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Video height as defined by sender"
},
"mime_type": {
"type": "string",
"description": "*Optional*. MIME type of the file as defined by sender"
},
"thumb": {
"type": "object",
"description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document) / [sticker](https://core.telegram.org/bots/api/#sticker) thumbnail.",
"required": [
"file_id",
"file_unique_id",
"height",
"width"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Photo height"
},
"width": {
"type": "integer",
"description": "Photo width"
}
}
},
"width": {
"type": "integer",
"description": "Video width as defined by sender"
}
}
},
"audio": {
"type": "object",
"description": "This object represents an audio file to be treated as music by the Telegram clients.",
"required": [
"duration",
"file_id",
"file_unique_id"
],
"properties": {
"duration": {
"type": "integer",
"description": "Duration of the audio in seconds as defined by sender"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_name": {
"type": "string",
"description": "*Optional*. Original filename as defined by sender"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"mime_type": {
"type": "string",
"description": "*Optional*. MIME type of the file as defined by sender"
},
"performer": {
"type": "string",
"description": "*Optional*. Performer of the audio as defined by sender or by audio tags"
},
"thumb": {
"type": "object",
"description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document) / [sticker](https://core.telegram.org/bots/api/#sticker) thumbnail.",
"required": [
"file_id",
"file_unique_id",
"height",
"width"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Photo height"
},
"width": {
"type": "integer",
"description": "Photo width"
}
}
},
"title": {
"type": "string",
"description": "*Optional*. Title of the audio as defined by sender or by audio tags"
}
}
},
"author_signature": {
"type": "string",
"description": "*Optional*. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator"
},
"caption": {
"type": "string",
"description": "*Optional*. Caption for the animation, audio, document, photo, video or voice, 0-1024 characters"
},
"caption_entities": {
"type": "array",
"description": "*Optional*. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption",
"items": {
"type": "object",
"description": "This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.",
"required": [
"type",
"offset",
"length"
],
"properties": {
"language": {
"type": "string",
"description": "*Optional*. For “pre” only, the programming language of the entity text"
},
"length": {
"type": "integer",
"description": "Length of the entity in UTF-16 code units"
},
"offset": {
"type": "integer",
"description": "Offset in UTF-16 code units to the start of the entity"
},
"type": {
"type": "string",
"description": "Type of the entity. 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), “code” (monowidth string), “pre” (monowidth block), “text\\_link” (for clickable text URLs), “text\\_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions))",
"enum": [
"mention",
"hashtag",
"cashtag",
"bot_command",
"url",
"email",
"phone_number",
"bold",
"italic",
"underline",
"strikethrough",
"code",
"pre",
"text_link",
"text_mention"
]
},
"url": {
"type": "string",
"description": "*Optional*. For “text\\_link” only, url that will be opened after user taps on the text"
},
"user": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"id",
"is_bot",
"first_name"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
}
}
}
},
"channel_chat_created": {
"type": "boolean",
"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."
},
"chat": {
"type": "object",
"description": "This object represents a chat.",
"required": [
"id",
"type"
],
"properties": {
"bio": {
"type": "string",
"description": "*Optional*. Bio of the other party in a private chat. Returned only in [getChat](https://core.telegram.org/bots/api/#getchat)."
},
"can_set_sticker_set": {
"type": "boolean",
"description": "*Optional*. True, if the bot can change the group sticker set. Returned only in [getChat](https://core.telegram.org/bots/api/#getchat)."
},
"description": {
"type": "string",
"description": "*Optional*. Description, for groups, supergroups and channel chats. Returned only in [getChat](https://core.telegram.org/bots/api/#getchat)."
},
"first_name": {
"type": "string",
"description": "*Optional*. First name of the other party in a private chat"
},
"id": {
"type": "integer",
"description": "Unique identifier for this chat. This number 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."
},
"invite_link": {
"type": "string",
"description": "*Optional*. Chat invite link, for groups, supergroups and channel chats. Each administrator in a chat generates their own invite links, so the bot must first generate the link using [exportChatInviteLink](https://core.telegram.org/bots/api/#exportchatinvitelink). Returned only in [getChat](https://core.telegram.org/bots/api/#getchat)."
},
"last_name": {
"type": "string",
"description": "*Optional*. Last name of the other party in a private chat"
},
"linked_chat_id": {
"type": "integer",
"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](https://core.telegram.org/bots/api/#getchat)."
},
"location": {
"type": "object",
"description": "Represents a location to which a chat is connected.",
"required": [
"address",
"location"
],
"properties": {
"address": {
"type": "string",
"description": "Location address; 1-64 characters, as defined by the chat owner"
},
"location": {
"type": "object",
"description": "This object represents a point on the map.",
"required": [
"latitude",
"longitude"
],
"properties": {
"heading": {
"type": "integer",
"description": "*Optional*. The direction in which user is moving, in degrees; 1-360. For active live locations only."
},
"horizontal_accuracy": {
"type": "number",
"description": "*Optional*. The radius of uncertainty for the location, measured in meters; 0-1500"
},
"latitude": {
"type": "number",
"description": "Latitude as defined by sender"
},
"live_period": {
"type": "integer",
"description": "*Optional*. Time relative to the message sending date, during which the location can be updated, in seconds. For active live locations only."
},
"longitude": {
"type": "number",
"description": "Longitude as defined by sender"
},
"proximity_alert_radius": {
"type": "integer",
"description": "*Optional*. Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only."
}
}
}
}
},
"permissions": {
"type": "object",
"description": "Describes actions that a non-administrator user is allowed to take in a chat.",
"properties": {
"can_add_web_page_previews": {
"type": "boolean",
"description": "*Optional*. True, if the user is allowed to add web page previews to their messages, implies can\\_send\\_media\\_messages"
},
"can_change_info": {
"type": "boolean",
"description": "*Optional*. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups"
},
"can_invite_users": {
"type": "boolean",
"description": "*Optional*. True, if the user is allowed to invite new users to the chat"
},
"can_pin_messages": {
"type": "boolean",
"description": "*Optional*. True, if the user is allowed to pin messages. Ignored in public supergroups"
},
"can_send_media_messages": {
"type": "boolean",
"description": "*Optional*. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can\\_send\\_messages"
},
"can_send_messages": {
"type": "boolean",
"description": "*Optional*. True, if the user is allowed to send text messages, contacts, locations and venues"
},
"can_send_other_messages": {
"type": "boolean",
"description": "*Optional*. True, if the user is allowed to send animations, games, stickers and use inline bots, implies can\\_send\\_media\\_messages"
},
"can_send_polls": {
"type": "boolean",
"description": "*Optional*. True, if the user is allowed to send polls, implies can\\_send\\_messages"
}
}
},
"photo": {
"type": "object",
"description": "This object represents a chat photo.",
"required": [
"big_file_id",
"big_file_unique_id",
"small_file_id",
"small_file_unique_id"
],
"properties": {
"big_file_id": {
"type": "string",
"description": "File identifier of big (640x640) chat photo. This file\\_id can be used only for photo download and only for as long as the photo is not changed."
},
"big_file_unique_id": {
"type": "string",
"description": "Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file."
},
"small_file_id": {
"type": "string",
"description": "File identifier of small (160x160) chat photo. This file\\_id can be used only for photo download and only for as long as the photo is not changed."
},
"small_file_unique_id": {
"type": "string",
"description": "Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file."
}
}
},
"pinned_message": {
"type": "object",
"additionalProperties": true
},
"slow_mode_delay": {
"type": "integer",
"description": "*Optional*. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user. Returned only in [getChat](https://core.telegram.org/bots/api/#getchat)."
},
"sticker_set_name": {
"type": "string",
"description": "*Optional*. For supergroups, name of group sticker set. Returned only in [getChat](https://core.telegram.org/bots/api/#getchat)."
},
"title": {
"type": "string",
"description": "*Optional*. Title, for supergroups, channels and group chats"
},
"type": {
"type": "string",
"description": "Type of chat, can be either “private”, “group”, “supergroup” or “channel”",
"enum": [
"private",
"group",
"supergroup",
"channel"
]
},
"username": {
"type": "string",
"description": "*Optional*. Username, for private chats, supergroups and channels if available"
}
}
},
"connected_website": {
"type": "string",
"description": "*Optional*. The domain name of the website on which the user has logged in. [More about Telegram Login »](/widgets/login)"
},
"contact": {
"type": "object",
"description": "This object represents a phone contact.",
"required": [
"first_name",
"phone_number"
],
"properties": {
"first_name": {
"type": "string",
"description": "Contact's first name"
},
"last_name": {
"type": "string",
"description": "*Optional*. Contact's last name"
},
"phone_number": {
"type": "string",
"description": "Contact's phone number"
},
"user_id": {
"type": "integer",
"description": "*Optional*. Contact's user identifier in Telegram"
},
"vcard": {
"type": "string",
"description": "*Optional*. Additional data about the contact in the form of a [vCard](https://en.wikipedia.org/wiki/VCard)"
}
}
},
"date": {
"type": "integer",
"description": "Date the message was sent in Unix time"
},
"delete_chat_photo": {
"type": "boolean",
"description": "*Optional*. Service message: the chat photo was deleted"
},
"dice": {
"type": "object",
"description": "This object represents an animated emoji that displays a random value.",
"required": [
"emoji",
"value"
],
"properties": {
"emoji": {
"type": "string",
"description": "Emoji on which the dice throw animation is based"
},
"value": {
"type": "integer",
"description": "Value of the dice, 1-6 for “<img alt=\"🎲\" src=\"//telegram.org/img/emoji/40/F09F8EB2.png\" height=\"20\" width=\"20\" />” and “<img alt=\"🎯\" src=\"//telegram.org/img/emoji/40/F09F8EAF.png\" height=\"20\" width=\"20\" />” base emoji, 1-5 for “<img alt=\"🏀\" src=\"//telegram.org/img/emoji/40/F09F8F80.png\" height=\"20\" width=\"20\" />” and “<img alt=\"⚽\" src=\"//telegram.org/img/emoji/40/E29ABD.png\" height=\"20\" width=\"20\" />” base emoji, 1-64 for “<img alt=\"🎰\" src=\"//telegram.org/img/emoji/40/F09F8EB0.png\" height=\"20\" width=\"20\" />” base emoji"
}
}
},
"document": {
"type": "object",
"description": "This object represents a general file (as opposed to [photos](https://core.telegram.org/bots/api/#photosize), [voice messages](https://core.telegram.org/bots/api/#voice) and [audio files](https://core.telegram.org/bots/api/#audio)).",
"required": [
"file_id",
"file_unique_id"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_name": {
"type": "string",
"description": "*Optional*. Original filename as defined by sender"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"mime_type": {
"type": "string",
"description": "*Optional*. MIME type of the file as defined by sender"
},
"thumb": {
"type": "object",
"description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document) / [sticker](https://core.telegram.org/bots/api/#sticker) thumbnail.",
"required": [
"file_id",
"file_unique_id",
"height",
"width"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Photo height"
},
"width": {
"type": "integer",
"description": "Photo width"
}
}
}
}
},
"edit_date": {
"type": "integer",
"description": "*Optional*. Date the message was last edited in Unix time"
},
"entities": {
"type": "array",
"description": "*Optional*. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text",
"items": {
"type": "object",
"description": "This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.",
"required": [
"type",
"offset",
"length"
],
"properties": {
"language": {
"type": "string",
"description": "*Optional*. For “pre” only, the programming language of the entity text"
},
"length": {
"type": "integer",
"description": "Length of the entity in UTF-16 code units"
},
"offset": {
"type": "integer",
"description": "Offset in UTF-16 code units to the start of the entity"
},
"type": {
"type": "string",
"description": "Type of the entity. 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), “code” (monowidth string), “pre” (monowidth block), “text\\_link” (for clickable text URLs), “text\\_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions))",
"enum": [
"mention",
"hashtag",
"cashtag",
"bot_command",
"url",
"email",
"phone_number",
"bold",
"italic",
"underline",
"strikethrough",
"code",
"pre",
"text_link",
"text_mention"
]
},
"url": {
"type": "string",
"description": "*Optional*. For “text\\_link” only, url that will be opened after user taps on the text"
},
"user": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"id",
"is_bot",
"first_name"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
}
}
}
},
"forward_date": {
"type": "integer",
"description": "*Optional*. For forwarded messages, date the original message was sent in Unix time"
},
"forward_from": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"first_name",
"id",
"is_bot"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
},
"forward_from_chat": {
"type": "object",
"additionalProperties": true
},
"forward_from_message_id": {
"type": "integer",
"description": "*Optional*. For messages forwarded from channels, identifier of the original message in the channel"
},
"forward_sender_name": {
"type": "string",
"description": "*Optional*. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages"
},
"forward_signature": {
"type": "string",
"description": "*Optional*. For messages forwarded from channels, signature of the post author if present"
},
"from": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"first_name",
"id",
"is_bot"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
},
"game": {
"type": "object",
"description": "This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.",
"required": [
"description",
"photo",
"title"
],
"properties": {
"animation": {
"type": "object",
"description": "This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).",
"required": [
"duration",
"file_id",
"file_unique_id",
"height",
"width"
],
"properties": {
"duration": {
"type": "integer",
"description": "Duration of the video in seconds as defined by sender"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_name": {
"type": "string",
"description": "*Optional*. Original animation filename as defined by sender"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Video height as defined by sender"
},
"mime_type": {
"type": "string",
"description": "*Optional*. MIME type of the file as defined by sender"
},
"thumb": {
"type": "object",
"description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document) / [sticker](https://core.telegram.org/bots/api/#sticker) thumbnail.",
"required": [
"file_id",
"file_unique_id",
"height",
"width"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Photo height"
},
"width": {
"type": "integer",
"description": "Photo width"
}
}
},
"width": {
"type": "integer",
"description": "Video width as defined by sender"
}
}
},
"description": {
"type": "string",
"description": "Description of the game"
},
"photo": {
"type": "array",
"description": "Photo that will be displayed in the game message in chats.",
"items": {
"type": "object",
"description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document) / [sticker](https://core.telegram.org/bots/api/#sticker) thumbnail.",
"required": [
"file_id",
"file_unique_id",
"width",
"height"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Photo height"
},
"width": {
"type": "integer",
"description": "Photo width"
}
}
}
},
"text": {
"type": "string",
"description": "*Optional*. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls [setGameScore](https://core.telegram.org/bots/api/#setgamescore), or manually edited using [editMessageText](https://core.telegram.org/bots/api/#editmessagetext). 0-4096 characters."
},
"text_entities": {
"type": "array",
"description": "*Optional*. Special entities that appear in *text*, such as usernames, URLs, bot commands, etc.",
"items": {
"type": "object",
"description": "This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.",
"required": [
"type",
"offset",
"length"
],
"properties": {
"language": {
"type": "string",
"description": "*Optional*. For “pre” only, the programming language of the entity text"
},
"length": {
"type": "integer",
"description": "Length of the entity in UTF-16 code units"
},
"offset": {
"type": "integer",
"description": "Offset in UTF-16 code units to the start of the entity"
},
"type": {
"type": "string",
"description": "Type of the entity. 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), “code” (monowidth string), “pre” (monowidth block), “text\\_link” (for clickable text URLs), “text\\_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions))",
"enum": [
"mention",
"hashtag",
"cashtag",
"bot_command",
"url",
"email",
"phone_number",
"bold",
"italic",
"underline",
"strikethrough",
"code",
"pre",
"text_link",
"text_mention"
]
},
"url": {
"type": "string",
"description": "*Optional*. For “text\\_link” only, url that will be opened after user taps on the text"
},
"user": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"id",
"is_bot",
"first_name"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
}
}
}
},
"title": {
"type": "string",
"description": "Title of the game"
}
}
},
"group_chat_created": {
"type": "boolean",
"description": "*Optional*. Service message: the group has been created"
},
"invoice": {
"type": "object",
"description": "This object contains basic information about an invoice.",
"required": [
"currency",
"description",
"start_parameter",
"title",
"total_amount"
],
"properties": {
"currency": {
"type": "string",
"description": "Three-letter ISO 4217 [currency](/bots/payments#supported-currencies) code"
},
"description": {
"type": "string",
"description": "Product description"
},
"start_parameter": {
"type": "string",
"description": "Unique bot deep-linking parameter that can be used to generate this invoice"
},
"title": {
"type": "string",
"description": "Product name"
},
"total_amount": {
"type": "integer",
"description": "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](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies)."
}
}
},
"left_chat_member": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"first_name",
"id",
"is_bot"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
},
"location": {
"type": "object",
"description": "This object represents a point on the map.",
"required": [
"latitude",
"longitude"
],
"properties": {
"heading": {
"type": "integer",
"description": "*Optional*. The direction in which user is moving, in degrees; 1-360. For active live locations only."
},
"horizontal_accuracy": {
"type": "number",
"description": "*Optional*. The radius of uncertainty for the location, measured in meters; 0-1500"
},
"latitude": {
"type": "number",
"description": "Latitude as defined by sender"
},
"live_period": {
"type": "integer",
"description": "*Optional*. Time relative to the message sending date, during which the location can be updated, in seconds. For active live locations only."
},
"longitude": {
"type": "number",
"description": "Longitude as defined by sender"
},
"proximity_alert_radius": {
"type": "integer",
"description": "*Optional*. Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only."
}
}
},
"media_group_id": {
"type": "string",
"description": "*Optional*. The unique identifier of a media message group this message belongs to"
},
"message_id": {
"type": "integer",
"description": "Unique message identifier inside this chat"
},
"migrate_from_chat_id": {
"type": "integer",
"description": "*Optional*. The supergroup has been migrated from a group with the specified identifier. This number 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."
},
"migrate_to_chat_id": {
"type": "integer",
"description": "*Optional*. The group has been migrated to a supergroup with the specified identifier. This number 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."
},
"new_chat_members": {
"type": "array",
"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)",
"items": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"id",
"is_bot",
"first_name"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
}
},
"new_chat_photo": {
"type": "array",
"description": "*Optional*. A chat photo was change to this value",
"items": {
"type": "object",
"description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document) / [sticker](https://core.telegram.org/bots/api/#sticker) thumbnail.",
"required": [
"file_id",
"file_unique_id",
"width",
"height"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Photo height"
},
"width": {
"type": "integer",
"description": "Photo width"
}
}
}
},
"new_chat_title": {
"type": "string",
"description": "*Optional*. A chat title was changed to this value"
},
"passport_data": {
"type": "object",
"description": "Contains information about Telegram Passport data shared with the bot by the user.",
"required": [
"credentials",
"data"
],
"properties": {
"credentials": {
"type": "object",
"description": "Contains data required for decrypting and authenticating [EncryptedPassportElement](https://core.telegram.org/bots/api/#encryptedpassportelement). See the [Telegram Passport Documentation](https://core.telegram.org/passport#receiving-information) for a complete description of the data decryption and authentication processes.",
"required": [
"data",
"hash",
"secret"
],
"properties": {
"data": {
"type": "string",
"description": "Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for [EncryptedPassportElement](https://core.telegram.org/bots/api/#encryptedpassportelement) decryption and authentication"
},
"hash": {
"type": "string",
"description": "Base64-encoded data hash for data authentication"
},
"secret": {
"type": "string",
"description": "Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption"
}
}
},
"data": {
"type": "array",
"description": "Array with information about documents and other Telegram Passport elements that was shared with the bot",
"items": {
"type": "object",
"description": "Contains information about documents or other Telegram Passport elements shared with the bot by the user.",
"required": [
"type",
"hash"
],
"properties": {
"data": {
"type": "string",
"description": "*Optional*. Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal\\_details”, “passport”, “driver\\_license”, “identity\\_card”, “internal\\_passport” and “address” types. Can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api/#encryptedcredentials)."
},
"email": {
"type": "string",
"description": "*Optional*. User's verified email address, available only for “email” type"
},
"files": {
"type": "array",
"description": "*Optional*. Array of encrypted files with documents provided by the user, available for “utility\\_bill”, “bank\\_statement”, “rental\\_agreement”, “passport\\_registration” and “temporary\\_registration” types. Files can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api/#encryptedcredentials).",
"items": {
"type": "object",
"description": "This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.",
"required": [
"file_id",
"file_unique_id",
"file_size",
"file_date"
],
"properties": {
"file_date": {
"type": "integer",
"description": "Unix time when the file was uploaded"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "File size"
},
"file_unique_id": {
"type": "string",
"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."
}
}
}
},
"front_side": {
"type": "object",
"description": "This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.",
"required": [
"file_id",
"file_unique_id",
"file_size",
"file_date"
],
"properties": {
"file_date": {
"type": "integer",
"description": "Unix time when the file was uploaded"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "File size"
},
"file_unique_id": {
"type": "string",
"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."
}
}
},
"hash": {
"type": "string",
"description": "Base64-encoded element hash for using in [PassportElementErrorUnspecified](https://core.telegram.org/bots/api/#passportelementerrorunspecified)"
},
"phone_number": {
"type": "string",
"description": "*Optional*. User's verified phone number, available only for “phone\\_number” type"
},
"reverse_side": {
"type": "object",
"description": "This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.",
"required": [
"file_id",
"file_unique_id",
"file_size",
"file_date"
],
"properties": {
"file_date": {
"type": "integer",
"description": "Unix time when the file was uploaded"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "File size"
},
"file_unique_id": {
"type": "string",
"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."
}
}
},
"selfie": {
"type": "object",
"description": "This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.",
"required": [
"file_id",
"file_unique_id",
"file_size",
"file_date"
],
"properties": {
"file_date": {
"type": "integer",
"description": "Unix time when the file was uploaded"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "File size"
},
"file_unique_id": {
"type": "string",
"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."
}
}
},
"translation": {
"type": "array",
"description": "*Optional*. Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver\\_license”, “identity\\_card”, “internal\\_passport”, “utility\\_bill”, “bank\\_statement”, “rental\\_agreement”, “passport\\_registration” and “temporary\\_registration” types. Files can be decrypted and verified using the accompanying [EncryptedCredentials](https://core.telegram.org/bots/api/#encryptedcredentials).",
"items": {
"type": "object",
"description": "This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.",
"required": [
"file_id",
"file_unique_id",
"file_size",
"file_date"
],
"properties": {
"file_date": {
"type": "integer",
"description": "Unix time when the file was uploaded"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "File size"
},
"file_unique_id": {
"type": "string",
"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."
}
}
}
},
"type": {
"type": "string",
"description": "Element type. One of “personal\\_details”, “passport”, “driver\\_license”, “identity\\_card”, “internal\\_passport”, “address”, “utility\\_bill”, “bank\\_statement”, “rental\\_agreement”, “passport\\_registration”, “temporary\\_registration”, “phone\\_number”, “email”.",
"enum": [
"personal_details",
"passport",
"driver_license",
"identity_card",
"internal_passport",
"address",
"utility_bill",
"bank_statement",
"rental_agreement",
"passport_registration",
"temporary_registration",
"phone_number",
"email"
]
}
}
}
}
}
},
"photo": {
"type": "array",
"description": "*Optional*. Message is a photo, available sizes of the photo",
"items": {
"type": "object",
"description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document) / [sticker](https://core.telegram.org/bots/api/#sticker) thumbnail.",
"required": [
"file_id",
"file_unique_id",
"width",
"height"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Photo height"
},
"width": {
"type": "integer",
"description": "Photo width"
}
}
}
},
"pinned_message": {
"type": "object",
"additionalProperties": true
},
"poll": {
"type": "object",
"description": "This object contains information about a poll.",
"required": [
"allows_multiple_answers",
"id",
"is_anonymous",
"is_closed",
"options",
"question",
"total_voter_count",
"type"
],
"properties": {
"allows_multiple_answers": {
"type": "boolean",
"description": "True, if the poll allows multiple answers"
},
"close_date": {
"type": "integer",
"description": "*Optional*. Point in time (Unix timestamp) when the poll will be automatically closed"
},
"correct_option_id": {
"type": "integer",
"description": "*Optional*. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot."
},
"explanation": {
"type": "string",
"description": "*Optional*. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters"
},
"explanation_entities": {
"type": "array",
"description": "*Optional*. Special entities like usernames, URLs, bot commands, etc. that appear in the *explanation*",
"items": {
"type": "object",
"description": "This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.",
"required": [
"type",
"offset",
"length"
],
"properties": {
"language": {
"type": "string",
"description": "*Optional*. For “pre” only, the programming language of the entity text"
},
"length": {
"type": "integer",
"description": "Length of the entity in UTF-16 code units"
},
"offset": {
"type": "integer",
"description": "Offset in UTF-16 code units to the start of the entity"
},
"type": {
"type": "string",
"description": "Type of the entity. 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), “code” (monowidth string), “pre” (monowidth block), “text\\_link” (for clickable text URLs), “text\\_mention” (for users [without usernames](https://telegram.org/blog/edit#new-mentions))",
"enum": [
"mention",
"hashtag",
"cashtag",
"bot_command",
"url",
"email",
"phone_number",
"bold",
"italic",
"underline",
"strikethrough",
"code",
"pre",
"text_link",
"text_mention"
]
},
"url": {
"type": "string",
"description": "*Optional*. For “text\\_link” only, url that will be opened after user taps on the text"
},
"user": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"id",
"is_bot",
"first_name"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
}
}
}
},
"id": {
"type": "string",
"description": "Unique poll identifier"
},
"is_anonymous": {
"type": "boolean",
"description": "True, if the poll is anonymous"
},
"is_closed": {
"type": "boolean",
"description": "True, if the poll is closed"
},
"open_period": {
"type": "integer",
"description": "*Optional*. Amount of time in seconds the poll will be active after creation"
},
"options": {
"type": "array",
"description": "List of poll options",
"items": {
"type": "object",
"description": "This object contains information about one answer option in a poll.",
"required": [
"text",
"voter_count"
],
"properties": {
"text": {
"type": "string",
"description": "Option text, 1-100 characters"
},
"voter_count": {
"type": "integer",
"description": "Number of users that voted for this option"
}
}
}
},
"question": {
"type": "string",
"description": "Poll question, 1-255 characters"
},
"total_voter_count": {
"type": "integer",
"description": "Total number of users that voted in the poll"
},
"type": {
"type": "string",
"description": "Poll type, currently can be “regular” or “quiz”"
}
}
},
"proximity_alert_triggered": {
"type": "object",
"description": "This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.",
"required": [
"distance",
"traveler",
"watcher"
],
"properties": {
"distance": {
"type": "integer",
"description": "The distance between the users"
},
"traveler": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"first_name",
"id",
"is_bot"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
},
"watcher": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"first_name",
"id",
"is_bot"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
}
}
},
"reply_markup": {
"type": "object",
"description": "This object represents an [inline keyboard](https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating) that appears right next to the message it belongs to.",
"required": [
"inline_keyboard"
],
"properties": {
"inline_keyboard": {
"type": "array",
"description": "Array of button rows, each represented by an Array of [InlineKeyboardButton](https://core.telegram.org/bots/api/#inlinekeyboardbutton) objects",
"items": {
"type": "array",
"items": {
"type": "object",
"description": "This object represents one button of an inline keyboard. You **must** use exactly one of the optional fields.",
"required": [
"text"
],
"properties": {
"callback_data": {
"type": "string",
"description": "*Optional*. Data to be sent in a [callback query](https://core.telegram.org/bots/api/#callbackquery) to the bot when button is pressed, 1-64 bytes"
},
"callback_game": {
"description": "A placeholder, currently holds no information. Use [BotFather](https://t.me/botfather) to set up your game.",
"type": "object"
},
"login_url": {
"type": "object",
"description": "This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the [Telegram Login Widget](https://core.telegram.org/widgets/login) when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:\n\nTelegram apps support these buttons as of [version 5.7](https://telegram.org/blog/privacy-discussions-web-bots#meet-seamless-web-bots).\n\nSample bot: [@discussbot](https://t.me/discussbot)",
"required": [
"url"
],
"properties": {
"bot_username": {
"type": "string",
"description": "*Optional*. Username of a bot, which will be used for user authorization. See [Setting up a bot](https://core.telegram.org/widgets/login#setting-up-a-bot) for more details. If not specified, the current bot's username will be assumed. The *url*'s domain must be the same as the domain linked with the bot. See [Linking your domain to the bot](https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot) for more details."
},
"forward_text": {
"type": "string",
"description": "*Optional*. New text of the button in forwarded messages."
},
"request_write_access": {
"type": "boolean",
"description": "*Optional*. Pass True to request the permission for your bot to send messages to the user."
},
"url": {
"type": "string",
"description": "An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in [Receiving authorization data](https://core.telegram.org/widgets/login#receiving-authorization-data). \n\n**NOTE:** You **must** always check the hash of the received data to verify the authentication and the integrity of the data as described in [Checking authorization](https://core.telegram.org/widgets/login#checking-authorization)."
}
}
},
"pay": {
"type": "boolean",
"description": "*Optional*. Specify True, to send a [Pay button](https://core.telegram.org/bots/api/#payments). \n\n**NOTE:** This type of button **must** always be the first button in the first row."
},
"switch_inline_query": {
"type": "string",
"description": "*Optional*. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. Can be empty, in which case just the bot's username will be inserted. \n\n**Note:** This offers an easy way for users to start using your bot in [inline mode](/bots/inline) when they are currently in a private chat with it. Especially useful when combined with [*switch\\_pm…*](https://core.telegram.org/bots/api/#answerinlinequery) actions – in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen."
},
"switch_inline_query_current_chat": {
"type": "string",
"description": "*Optional*. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot's username will be inserted. \n\nThis offers a quick way for the user to open your bot in inline mode in the same chat – good for selecting something from multiple options."
},
"text": {
"type": "string",
"description": "Label text on the button"
},
"url": {
"type": "string",
"description": "*Optional*. HTTP or tg:// url to be opened when button is pressed"
}
}
}
}
}
}
},
"reply_to_message": {
"type": "object",
"additionalProperties": true
},
"sender_chat": {
"type": "object",
"additionalProperties": true
},
"sticker": {
"type": "object",
"description": "This object represents a sticker.",
"required": [
"file_id",
"file_unique_id",
"height",
"is_animated",
"width"
],
"properties": {
"emoji": {
"type": "string",
"description": "*Optional*. Emoji associated with the sticker"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Sticker height"
},
"is_animated": {
"type": "boolean",
"description": "*True*, if the sticker is [animated](https://telegram.org/blog/animated-stickers)"
},
"mask_position": {
"type": "object",
"description": "This object describes the position on faces where a mask should be placed by default.",
"required": [
"point",
"scale",
"x_shift",
"y_shift"
],
"properties": {
"point": {
"type": "string",
"description": "The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.",
"enum": [
"forehead",
"eyes",
"mouth",
"chin"
]
},
"scale": {
"type": "number",
"description": "Mask scaling coefficient. For example, 2.0 means double size."
},
"x_shift": {
"type": "number",
"description": "Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position."
},
"y_shift": {
"type": "number",
"description": "Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position."
}
}
},
"set_name": {
"type": "string",
"description": "*Optional*. Name of the sticker set to which the sticker belongs"
},
"thumb": {
"type": "object",
"description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document) / [sticker](https://core.telegram.org/bots/api/#sticker) thumbnail.",
"required": [
"file_id",
"file_unique_id",
"height",
"width"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Photo height"
},
"width": {
"type": "integer",
"description": "Photo width"
}
}
},
"width": {
"type": "integer",
"description": "Sticker width"
}
}
},
"successful_payment": {
"type": "object",
"description": "This object contains basic information about a successful payment.",
"required": [
"currency",
"invoice_payload",
"provider_payment_charge_id",
"telegram_payment_charge_id",
"total_amount"
],
"properties": {
"currency": {
"type": "string",
"description": "Three-letter ISO 4217 [currency](/bots/payments#supported-currencies) code"
},
"invoice_payload": {
"type": "string",
"description": "Bot specified invoice payload"
},
"order_info": {
"type": "object",
"description": "This object represents information about an order.",
"properties": {
"email": {
"type": "string",
"description": "*Optional*. User email"
},
"name": {
"type": "string",
"description": "*Optional*. User name"
},
"phone_number": {
"type": "string",
"description": "*Optional*. User's phone number"
},
"shipping_address": {
"type": "object",
"description": "This object represents a shipping address.",
"required": [
"city",
"country_code",
"post_code",
"state",
"street_line1",
"street_line2"
],
"properties": {
"city": {
"type": "string",
"description": "City"
},
"country_code": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code"
},
"post_code": {
"type": "string",
"description": "Address post code"
},
"state": {
"type": "string",
"description": "State, if applicable"
},
"street_line1": {
"type": "string",
"description": "First line for the address"
},
"street_line2": {
"type": "string",
"description": "Second line for the address"
}
}
}
}
},
"provider_payment_charge_id": {
"type": "string",
"description": "Provider payment identifier"
},
"shipping_option_id": {
"type": "string",
"description": "*Optional*. Identifier of the shipping option chosen by the user"
},
"telegram_payment_charge_id": {
"type": "string",
"description": "Telegram payment identifier"
},
"total_amount": {
"type": "integer",
"description": "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](https://core.telegram.org/bots/payments/currencies.json), it shows the number of digits past the decimal point for each currency (2 for the majority of currencies)."
}
}
},
"supergroup_chat_created": {
"type": "boolean",
"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."
},
"text": {
"type": "string",
"description": "*Optional*. For text messages, the actual UTF-8 text of the message, 0-4096 characters"
},
"venue": {
"type": "object",
"description": "This object represents a venue.",
"required": [
"address",
"location",
"title"
],
"properties": {
"address": {
"type": "string",
"description": "Address of the venue"
},
"foursquare_id": {
"type": "string",
"description": "*Optional*. Foursquare identifier of the venue"
},
"foursquare_type": {
"type": "string",
"description": "*Optional*. Foursquare type of the venue. (For example, “arts\\_entertainment/default”, “arts\\_entertainment/aquarium” or “food/icecream”.)"
},
"google_place_id": {
"type": "string",
"description": "*Optional*. Google Places identifier of the venue"
},
"google_place_type": {
"type": "string",
"description": "*Optional*. Google Places type of the venue. (See [supported types](https://developers.google.com/places/web-service/supported_types).)"
},
"location": {
"type": "object",
"description": "This object represents a point on the map.",
"required": [
"latitude",
"longitude"
],
"properties": {
"heading": {
"type": "integer",
"description": "*Optional*. The direction in which user is moving, in degrees; 1-360. For active live locations only."
},
"horizontal_accuracy": {
"type": "number",
"description": "*Optional*. The radius of uncertainty for the location, measured in meters; 0-1500"
},
"latitude": {
"type": "number",
"description": "Latitude as defined by sender"
},
"live_period": {
"type": "integer",
"description": "*Optional*. Time relative to the message sending date, during which the location can be updated, in seconds. For active live locations only."
},
"longitude": {
"type": "number",
"description": "Longitude as defined by sender"
},
"proximity_alert_radius": {
"type": "integer",
"description": "*Optional*. Maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only."
}
}
},
"title": {
"type": "string",
"description": "Name of the venue"
}
}
},
"via_bot": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"first_name",
"id",
"is_bot"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
},
"video": {
"type": "object",
"description": "This object represents a video file.",
"required": [
"duration",
"file_id",
"file_unique_id",
"height",
"width"
],
"properties": {
"duration": {
"type": "integer",
"description": "Duration of the video in seconds as defined by sender"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_name": {
"type": "string",
"description": "*Optional*. Original filename as defined by sender"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Video height as defined by sender"
},
"mime_type": {
"type": "string",
"description": "*Optional*. Mime type of a file as defined by sender"
},
"thumb": {
"type": "object",
"description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document) / [sticker](https://core.telegram.org/bots/api/#sticker) thumbnail.",
"required": [
"file_id",
"file_unique_id",
"height",
"width"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Photo height"
},
"width": {
"type": "integer",
"description": "Photo width"
}
}
},
"width": {
"type": "integer",
"description": "Video width as defined by sender"
}
}
},
"video_note": {
"type": "object",
"description": "This object represents a [video message](https://telegram.org/blog/video-messages-and-telescope) (available in Telegram apps as of [v.4.0](https://telegram.org/blog/video-messages-and-telescope)).",
"required": [
"duration",
"file_id",
"file_unique_id",
"length"
],
"properties": {
"duration": {
"type": "integer",
"description": "Duration of the video in seconds as defined by sender"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"length": {
"type": "integer",
"description": "Video width and height (diameter of the video message) as defined by sender"
},
"thumb": {
"type": "object",
"description": "This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document) / [sticker](https://core.telegram.org/bots/api/#sticker) thumbnail.",
"required": [
"file_id",
"file_unique_id",
"height",
"width"
],
"properties": {
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"height": {
"type": "integer",
"description": "Photo height"
},
"width": {
"type": "integer",
"description": "Photo width"
}
}
}
}
},
"voice": {
"type": "object",
"description": "This object represents a voice note.",
"required": [
"duration",
"file_id",
"file_unique_id"
],
"properties": {
"duration": {
"type": "integer",
"description": "Duration of the audio in seconds as defined by sender"
},
"file_id": {
"type": "string",
"description": "Identifier for this file, which can be used to download or reuse the file"
},
"file_size": {
"type": "integer",
"description": "*Optional*. File size"
},
"file_unique_id": {
"type": "string",
"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."
},
"mime_type": {
"type": "string",
"description": "*Optional*. MIME type of the file as defined by sender"
}
}
}
}
}
}
}