-
Notifications
You must be signed in to change notification settings - Fork 13
/
v100.json
672 lines (672 loc) · 30 KB
/
v100.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
{
"info": {
"name": "Telegram Bot API",
"description": "Auto-generated Postman collection by TGScraper.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"version": "1.0.0"
},
"variable": {
"key": "token",
"description": "Bot's unique authentication token, given by @BotFather.",
"type": "string",
"value": "1234:AAbbcc"
},
"item": [
{
"name": "getUpdates",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "offset",
"disabled": true,
"description": "Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id.",
"type": "text"
},
{
"key": "limit",
"disabled": true,
"description": "Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100",
"type": "text",
"value": "100"
},
{
"key": "timeout",
"disabled": true,
"description": "Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getUpdates",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getUpdates"
]
},
"description": "Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned."
}
},
{
"name": "setWebhook",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "url",
"disabled": true,
"description": "Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/setWebhook",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"setWebhook"
]
},
"description": "Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts.\nIf you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. www.example.com/<token>. Since nobody else knows your bot‘s token, you can be pretty sure it’s us."
}
},
{
"name": "getMe",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": []
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getMe",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getMe"
]
},
"description": "A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object."
}
},
{
"name": "sendMessage",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "text",
"disabled": false,
"description": "Required. Text of the message to be sent",
"type": "text"
},
{
"key": "disable_web_page_preview",
"disabled": true,
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendMessage",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendMessage"
]
},
"description": "Use this method to send text messages. On success, the sent Message is returned."
}
},
{
"name": "forwardMessage",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "from_chat_id",
"disabled": false,
"description": "Required. Unique identifier for the chat where the original message was sent — User or GroupChat id",
"type": "text"
},
{
"key": "message_id",
"disabled": false,
"description": "Required. Unique message identifier",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/forwardMessage",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"forwardMessage"
]
},
"description": "Use this method to forward messages of any kind. On success, the sent Message is returned."
}
},
{
"name": "sendPhoto",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "photo",
"disabled": false,
"description": "Required. Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo using multipart/form-data.",
"type": "text"
},
{
"key": "caption",
"disabled": true,
"description": "Optional. Photo caption (may also be used when resending photos by file_id).",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendPhoto",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendPhoto"
]
},
"description": "Use this method to send photos. On success, the sent Message is returned."
}
},
{
"name": "sendAudio",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "audio",
"disabled": false,
"description": "Required. Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendAudio",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendAudio"
]
},
"description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future."
}
},
{
"name": "sendDocument",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "document",
"disabled": false,
"description": "Required. File to send. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendDocument",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendDocument"
]
},
"description": "Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future."
}
},
{
"name": "sendSticker",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "sticker",
"disabled": false,
"description": "Required. Sticker to send. You can either pass a file_id as String to resend a sticker that is already on the Telegram servers, or upload a new sticker using multipart/form-data.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendSticker",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendSticker"
]
},
"description": "Use this method to send .webp stickers. On success, the sent Message is returned."
}
},
{
"name": "sendVideo",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "video",
"disabled": false,
"description": "Required. Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file using multipart/form-data.",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendVideo",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVideo"
]
},
"description": "Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future."
}
},
{
"name": "sendLocation",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "latitude",
"disabled": false,
"description": "Required. Latitude of location",
"type": "text"
},
{
"key": "longitude",
"disabled": false,
"description": "Required. Longitude of location",
"type": "text"
},
{
"key": "reply_to_message_id",
"disabled": true,
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"disabled": true,
"description": "Optional. Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendLocation",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendLocation"
]
},
"description": "Use this method to send point on the map. On success, the sent Message is returned."
}
},
{
"name": "sendChatAction",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "chat_id",
"disabled": false,
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "action",
"disabled": false,
"description": "Required. Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_audio or upload_audio for audio files, upload_document for general files, find_location for location data.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/sendChatAction",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendChatAction"
]
},
"description": "Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).\nWe only recommend using this method when a response from the bot will take a noticeable amount of time to arrive."
}
},
{
"name": "getUserProfilePhotos",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "Parameters",
"disabled": true,
"description": "Optional. Description",
"type": "text"
},
{
"key": "user_id",
"disabled": false,
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "offset",
"disabled": true,
"description": "Optional. Sequential number of the first photo to be returned. By default, all photos are returned.",
"type": "text"
},
{
"key": "limit",
"disabled": true,
"description": "Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text",
"value": "100"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getUserProfilePhotos",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getUserProfilePhotos"
]
},
"description": "Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object."
}
}
]
}