davtur19/telegram-bot-api-versions
1
0
Fork 0
mirror of https://github.com/sys-001/telegram-bot-api-versions.git synced 2024-11-23 03:46:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added YAML and Postman formats, updated old JSON schemas

Browse Source
This commit is contained in:
Sys 2021-07-24 23:05:28 +02:00
parent ea3c495861
commit 9970e121ba
No known key found for this signature in database
GPG Key ID: 3CD2C29F8AB39BFD
107 changed files with 250422 additions and 197 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
composer.phar
/vendor/
/.idea/

97
README.md
View File

@ -2,55 +2,58 @@
This repository aims to store a schema for every version of the Telegram Bot API.
The goal is achieved by using [TGScraper](https://github.com/Sysbot-org/tgscraper). Old bot API schemas have been extracted by using [The Wayback Machine](https://web.archive.org/web/*/https://core.telegram.org/bots/api).
**NOTE: some versions may be broken, I haven't tested nor checked everything.**
The goal is achieved by using [TGScraper](https://github.com/Sysbot-org/tgscraper). Old bot API schemas have been
extracted by using [The Wayback Machine](https://web.archive.org/web/*/https://core.telegram.org/bots/api).
## Versions list
| Version | Description | Release date | Schema |
|-------------------|-----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
| 1.0 | First release. | [June 24, 2015](https://core.telegram.org/bots/api-changelog#june-24-2015) | [v1.0.json](files/v1.0.json) |
| 1.1 | Minor changes. | [July 2015](https://core.telegram.org/bots/api-changelog#july-2015) | [v1.1.json](files/v1.1.json) |
| 1.2 | Voice messages. | [August 15, 2015](https://core.telegram.org/bots/api-changelog#august-15-2015) | Not available. |
| 1.3 | Support for self-signed certificates and webhook payload requests. | [August 29, 2015](https://core.telegram.org/bots/api-changelog#august-29-2015) | Not available. |
| 1.4 | JSON requests, basic Markdown support. | [September 7, 2015](https://core.telegram.org/bots/api-changelog#september-7-2015) | [v1.4.json](files/v1.4.json) |
| 1.5 | Download files and media sent by users. | [September 18, 2015](https://core.telegram.org/bots/api-changelog#september-18-2015) | [v1.5.json](files/v1.5.json) |
| 1.6 | Introduced channel support for bots. | [October 8, 2015](https://core.telegram.org/bots/api-changelog#october-8-2015) | [v1.6.json](files/v1.6.json) |
| 1.7 | Introduced supergroup support for bots. | [November 2015](https://core.telegram.org/bots/api-changelog#november-2015) | Not available. |
| 1.8 | Inline mode support. | [January 4, 2016](https://core.telegram.org/bots/api-changelog#january-4-2016) | [v1.8.json](files/v1.8.json) |
| 1.8.1 | Added ChosenInlineResult. | [January 14, 2016](https://core.telegram.org/bots/api-changelog#january-14-2016) | Not available. |
| 1.8.2 | Added support for HTML-style formatting. | [January 20, 2016](https://core.telegram.org/bots/api-changelog#january-20-2016) | [v1.8.2.json](files/v1.8.2.json) |
| 1.8.3 | Support for sending silent messages. | [February 20, 2016](https://core.telegram.org/bots/api-changelog#february-20-2016) | [v1.8.3.json](files/v1.8.3.json) |
| 2.0 | Message editing, inline keyboards introduced, improved inline mode, basic administration tools. | [April 9, 2016](https://core.telegram.org/bots/api-changelog#april-9-2016) | [v2.0.json](files/v2.0.json) |
| 2.0.1 | Minor changes. | [May 6, 2016](https://core.telegram.org/bots/api-changelog#may-6-2016) | Not available. |
| 2.0.2 | Message consistency for bot in groups and supergroups. | [May 12, 2016](https://core.telegram.org/bots/api-changelog#may-12-2016) | Not available. |
| 2.1 | More administration tools, support for edited messages and mentions. | [May 22, 2016](https://core.telegram.org/bots/api-changelog#may-22-2016) | [v2.1.json](files/v2.1.json) |
| 2.1.1 | Added support for inline keyboards in groups. | [May 25, 2016](https://core.telegram.org/bots/api-changelog#may-25-2016) | [v2.1.json](files/v2.1.json)* |
| 2.2 | Gaming Platform, various changes. | [October 3, 2016](https://core.telegram.org/bots/api-changelog#october-3-2016) | [v2.2.json](files/v2.2.json) |
| 2.3 | Channel post updates, callback query cache, other changes. | [November 21, 2016](https://core.telegram.org/bots/api-changelog#november-21-2016) | [v2.3.json](files/v2.3.json) |
| 2.3.1 | Webhook improvements. | [December 4, 2016](https://core.telegram.org/bots/api-changelog#december-4-2016) | [v2.3.1.json](files/v2.3.1.json) |
| 3.0 | Payment Platform, video messages, language code. | [May 18, 2017](https://core.telegram.org/bots/api-changelog#may-18-2017) | [v3.0.json](files/v3.0.json) |
| 3.1 | ChatMember permissions, temporary bans, support for pinning and unpinning messages. | [June 30, 2017](https://core.telegram.org/bots/api-changelog#june-30-2017) | [v3.1.json](files/v3.1.json) |
| 3.2 | Support for sticker sets management. | [July 21, 2017](https://core.telegram.org/bots/api-changelog#july-21-2017) | [v3.2.json](files/v3.2.json) |
| 3.3 | Support for creating mentions, other minor changes. | [August 23, 2017](https://core.telegram.org/bots/api-changelog#august-23-2017) | [v3.3.json](files/v3.3.json) |
| 3.4 | Support for Live Location and group sticker sets management. | [October 11, 2017](https://core.telegram.org/bots/api-changelog#october-11-2017) | Not available. |
| 3.5 | Media albums, message pinning in channel. | [November 17, 2017](https://core.telegram.org/bots/api-changelog#november-17-2017) | [v3.5.json](files/v3.5.json) |
| 3.6 | Text formatting in captions, Login Widget support. | [February 13, 2018](https://core.telegram.org/bots/api-changelog#february-13-2018) | [v3.6.json](files/v3.6.json) |
| 4.0 | Telegram Passport, edit media content in messages, other major changes. | [July 26, 2018](https://core.telegram.org/bots/api-changelog#july-26-2018) | [v4.0.json](files/v4.0.json) |
| 4.1 | Minor changes for Telegram Passport. | [August 27, 2018](https://core.telegram.org/bots/api-changelog#august-27-2018) | [v4.1.json](files/v4.1.json) |
| 4.2 | Added Poll support, pin messages in basic groups, other major changes. | [April 14, 2019](https://core.telegram.org/bots/api-changelog#april-14-2019) | [v4.2.json](files/v4.2.json) |
| 4.3 | Seamless Telegram Login, ReplyMarkup included in Message object. | [May 31, 2019](https://core.telegram.org/bots/api-changelog#may-31-2019) | [v4.3.json](files/v4.3.json) |
| 4.4 | Support for animated stickers and default chat permissions. | [July 29, 2019](https://core.telegram.org/bots/api-changelog#july-29-2019) | [v4.4.json](files/v4.4.json) |
| 4.5 | MarkdownV2 support, nested Message entities, file unique ID, custom administrator title. | [December 31, 2019](https://core.telegram.org/bots/api-changelog#december-31-2019) | [v4.5.json](files/v4.5.json) |
| 4.6 | Polls 2.0, improved getMe. | [January 23, 2020](https://core.telegram.org/bots/api-changelog#january-23-2020) | [v4.6.json](files/v4.6.json) |
| 4.7 | Dice support, setMyCommands and getMyCommands, support for creating animated sticker packs. | [March 30, 2020](https://core.telegram.org/bots/api-changelog#march-30-2020) | [v4.7.json](files/v4.7.json) |
| 4.8 | Dart support for dice, explanations for quizzes, automatically close poll. | [April 24, 2020](https://core.telegram.org/bots/api-changelog#april-24-2020) | [v4.8.json](files/v4.8.json) |
| 4.9 | via_bot field in Message object, basketball support for dice. | [June 4, 2020](https://core.telegram.org/bots/api-changelog#june-4-2020) | [v4.9.json](files/v4.9.json) |
| 5.0 | Self-host Bot API, transfer bot ownership, other major changes. | [November 4, 2020](https://core.telegram.org/bots/api-changelog#november-4-2020) | [v5.0.json](files/v5.0.json) |
| 5.1 | New Update type: ChatMemberUpdated. Improved chat invite links, voice chats support, other major changes. | [March 9, 2021](https://core.telegram.org/bots/api-changelog#march-9-2021) | [v5.1.json](files/v5.1.json) |
| 5.2 | Payments 2.0, other minor changes. | [April 26, 2021](https://core.telegram.org/bots/api-changelog#april-26-2021) | [v5.2.json](files/v5.2.json) |
| 5.3 **(current)** | Scoped commands, ChatMember splitting | [June 25, 2021](https://core.telegram.org/bots/api-changelog#june-25-2021) | [v5.3.json](files/v5.3.json) |
| Version | Description | Release date | Schema |
|-------------------|-----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
| 1.0 | First release. | [June 24, 2015](https://core.telegram.org/bots/api-changelog#june-24-2015) | [JSON](files/json/v100.json), [Postman](files/postman/v100.json), [YAML](files/yaml/v100.yaml) |
| 1.1 | Minor changes. | [July 2015](https://core.telegram.org/bots/api-changelog#july-2015) | [JSON](files/json/v110.json), [Postman](files/postman/v110.json), [YAML](files/yaml/v110.yaml) |
| 1.2 | Voice messages. | [August 15, 2015](https://core.telegram.org/bots/api-changelog#august-15-2015) | Not available. |
| 1.3 | Support for self-signed certificates and webhook payload requests. | [August 29, 2015](https://core.telegram.org/bots/api-changelog#august-29-2015) | Not available. |
| 1.4 | JSON requests, basic Markdown support. | [September 7, 2015](https://core.telegram.org/bots/api-changelog#september-7-2015) | [JSON](files/json/v140.json), [Postman](files/postman/v140.json), [YAML](files/yaml/v140.yaml) |
| 1.5 | Download files and media sent by users. | [September 18, 2015](https://core.telegram.org/bots/api-changelog#september-18-2015) | [JSON](files/json/v150.json), [Postman](files/postman/v150.json), [YAML](files/yaml/v150.yaml) |
| 1.6 | Introduced channel support for bots. | [October 8, 2015](https://core.telegram.org/bots/api-changelog#october-8-2015) | [JSON](files/json/v160.json), [Postman](files/postman/v160.json), [YAML](files/yaml/v160.yaml) |
| 1.7 | Introduced supergroup support for bots. | [November 2015](https://core.telegram.org/bots/api-changelog#november-2015) | Not available. |
| 1.8 | Inline mode support. | [January 4, 2016](https://core.telegram.org/bots/api-changelog#january-4-2016) | [JSON](files/json/v180.json), [Postman](files/postman/v180.json), [YAML](files/yaml/v180.yaml) |
| 1.8.1 | Added ChosenInlineResult. | [January 14, 2016](https://core.telegram.org/bots/api-changelog#january-14-2016) | Not available. |
| 1.8.2 | Added support for HTML-style formatting. | [January 20, 2016](https://core.telegram.org/bots/api-changelog#january-20-2016) | [JSON](files/json/v182.json), [Postman](files/postman/v182.json), [YAML](files/yaml/v182.yaml) |
| 1.8.3 | Support for sending silent messages. | [February 20, 2016](https://core.telegram.org/bots/api-changelog#february-20-2016) | [JSON](files/json/v183.json), [Postman](files/postman/v183.json), [YAML](files/yaml/v183.yaml) |
| 2.0 | Message editing, inline keyboards introduced, improved inline mode, basic administration tools. | [April 9, 2016](https://core.telegram.org/bots/api-changelog#april-9-2016) | [JSON](files/json/v200.json), [Postman](files/postman/v200.json), [YAML](files/yaml/v200.yaml) |
| 2.0.1 | Minor changes. | [May 6, 2016](https://core.telegram.org/bots/api-changelog#may-6-2016) | Not available. |
| 2.0.2 | Message consistency for bot in groups and supergroups. | [May 12, 2016](https://core.telegram.org/bots/api-changelog#may-12-2016) | Not available. |
| 2.1 | More administration tools, support for edited messages and mentions. | [May 22, 2016](https://core.telegram.org/bots/api-changelog#may-22-2016) | [JSON](files/json/v210.json), [Postman](files/postman/v210.json), [YAML](files/yaml/v210.yaml) |
| 2.1.1 | Added support for inline keyboards in groups. | [May 25, 2016](https://core.telegram.org/bots/api-changelog#may-25-2016) | [JSON](files/json/v211.json)\*, [Postman](files/postman/v211.json)\*, [YAML](files/yaml/v211.yaml)* |
| 2.2 | Gaming Platform, various changes. | [October 3, 2016](https://core.telegram.org/bots/api-changelog#october-3-2016) | [JSON](files/json/v220.json), [Postman](files/postman/v220.json), [YAML](files/yaml/v220.yaml) |
| 2.3 | Channel post updates, callback query cache, other changes. | [November 21, 2016](https://core.telegram.org/bots/api-changelog#november-21-2016) | [JSON](files/json/v230.json), [Postman](files/postman/v230.json), [YAML](files/yaml/v230.yaml) |
| 2.3.1 | Webhook improvements. | [December 4, 2016](https://core.telegram.org/bots/api-changelog#december-4-2016) | [JSON](files/json/v231.json), [Postman](files/postman/v231.json), [YAML](files/yaml/v231.yaml) |
| 3.0 | Payment Platform, video messages, language code. | [May 18, 2017](https://core.telegram.org/bots/api-changelog#may-18-2017) | [JSON](files/json/v300.json), [Postman](files/postman/v300.json), [YAML](files/yaml/v300.yaml) |
| 3.1 | ChatMember permissions, temporary bans, support for pinning and unpinning messages. | [June 30, 2017](https://core.telegram.org/bots/api-changelog#june-30-2017) | [JSON](files/json/v310.json), [Postman](files/postman/v310.json), [YAML](files/yaml/v310.yaml) |
| 3.2 | Support for sticker sets management. | [July 21, 2017](https://core.telegram.org/bots/api-changelog#july-21-2017) | [JSON](files/json/v320.json), [Postman](files/postman/v320.json), [YAML](files/yaml/v320.yaml) |
| 3.3 | Support for creating mentions, other minor changes. | [August 23, 2017](https://core.telegram.org/bots/api-changelog#august-23-2017) | [JSON](files/json/v330.json), [Postman](files/postman/v330.json), [YAML](files/yaml/v330.yaml) |
| 3.4 | Support for Live Location and group sticker sets management. | [October 11, 2017](https://core.telegram.org/bots/api-changelog#october-11-2017) | Not available. |
| 3.5 | Media albums, message pinning in channel. | [November 17, 2017](https://core.telegram.org/bots/api-changelog#november-17-2017) | [JSON](files/json/v350.json), [Postman](files/postman/v350.json), [YAML](files/yaml/v350.yaml) |
| 3.6 | Text formatting in captions, Login Widget support. | [February 13, 2018](https://core.telegram.org/bots/api-changelog#february-13-2018) | [JSON](files/json/v360.json), [Postman](files/postman/v360.json), [YAML](files/yaml/v360.yaml) |
| 4.0 | Telegram Passport, edit media content in messages, other major changes. | [July 26, 2018](https://core.telegram.org/bots/api-changelog#july-26-2018) | [JSON](files/json/v400.json), [Postman](files/postman/v400.json), [YAML](files/yaml/v400.yaml) |
| 4.1 | Minor changes for Telegram Passport. | [August 27, 2018](https://core.telegram.org/bots/api-changelog#august-27-2018) | [JSON](files/json/v410.json), [Postman](files/postman/v410.json), [YAML](files/yaml/v410.yaml) |
| 4.2 | Added Poll support, pin messages in basic groups, other major changes. | [April 14, 2019](https://core.telegram.org/bots/api-changelog#april-14-2019) | [JSON](files/json/v420.json), [Postman](files/postman/v420.json), [YAML](files/yaml/v420.yaml) |
| 4.3 | Seamless Telegram Login, ReplyMarkup included in Message object. | [May 31, 2019](https://core.telegram.org/bots/api-changelog#may-31-2019) | [JSON](files/json/v430.json), [Postman](files/postman/v430.json), [YAML](files/yaml/v430.yaml) |
| 4.4 | Support for animated stickers and default chat permissions. | [July 29, 2019](https://core.telegram.org/bots/api-changelog#july-29-2019) | [JSON](files/json/v440.json), [Postman](files/postman/v440.json), [YAML](files/yaml/v440.yaml) |
| 4.5 | MarkdownV2 support, nested Message entities, file unique ID, custom administrator title. | [December 31, 2019](https://core.telegram.org/bots/api-changelog#december-31-2019) | [JSON](files/json/v450.json), [Postman](files/postman/v450.json), [YAML](files/yaml/v450.yaml) |
| 4.6 | Polls 2.0, improved getMe. | [January 23, 2020](https://core.telegram.org/bots/api-changelog#january-23-2020) | [JSON](files/json/v460.json), [Postman](files/postman/v460.json), [YAML](files/yaml/v460.yaml) |
| 4.7 | Dice support, setMyCommands and getMyCommands, support for creating animated sticker packs. | [March 30, 2020](https://core.telegram.org/bots/api-changelog#march-30-2020) | [JSON](files/json/v470.json), [Postman](files/postman/v470.json), [YAML](files/yaml/v470.yaml) |
| 4.8 | Dart support for dice, explanations for quizzes, automatically close poll. | [April 24, 2020](https://core.telegram.org/bots/api-changelog#april-24-2020) | [JSON](files/json/v480.json), [Postman](files/postman/v480.json), [YAML](files/yaml/v480.yaml) |
| 4.9 | via_bot field in Message object, basketball support for dice. | [June 4, 2020](https://core.telegram.org/bots/api-changelog#june-4-2020) | [JSON](files/json/v490.json), [Postman](files/postman/v490.json), [YAML](files/yaml/v490.yaml) |
| 5.0 | Self-host Bot API, transfer bot ownership, other major changes. | [November 4, 2020](https://core.telegram.org/bots/api-changelog#november-4-2020) | [JSON](files/json/v500.json), [Postman](files/postman/v500.json), [YAML](files/yaml/v500.yaml) |
| 5.1 | New Update type: ChatMemberUpdated. Improved chat invite links, voice chats support, other major changes. | [March 9, 2021](https://core.telegram.org/bots/api-changelog#march-9-2021) | [JSON](files/json/v510.json), [Postman](files/postman/v510.json), [YAML](files/yaml/v510.yaml) |
| 5.2 | Payments 2.0, other minor changes. | [April 26, 2021](https://core.telegram.org/bots/api-changelog#april-26-2021) | [JSON](files/json/v520.json), [Postman](files/postman/v520.json), [YAML](files/yaml/v520.yaml) |
| 5.3 **(current)** | Scoped commands, ChatMember splitting | [June 25, 2021](https://core.telegram.org/bots/api-changelog#june-25-2021) | [JSON](files/json/v530.json), [Postman](files/postman/v530.json), [YAML](files/yaml/v530.yaml) |
*Unchanged from previous version.
*Unchanged from previous version.
## Found a missing version?
Please, open an issue [here](https://github.com/sys-001/telegram-bot-api-versions/issues) providing the link and specifying the target version. It would help a lot!

5
composer.json Normal file
View File

@ -0,0 +1,5 @@
{
"require": {
"sysbot/tgscraper": "^2.0"
}
}

1889
composer.lock generated Normal file
View File

File diff suppressed because it is too large Load Diff

23
extract.php Normal file
View File

@ -0,0 +1,23 @@
<?php
use Psr\Log\NullLogger;
use TgScraper\Constants\Versions;
require_once __DIR__ . '/vendor/autoload.php';
$logger = new NullLogger();
$versions = (new ReflectionClass(Versions::class))
->getConstants();
unset($versions['LATEST']);
foreach ($versions as $version => $url) {
$filename = strtolower($version);
$generator = new \TgScraper\Generator($logger, url: $url);
$json = $generator->toJson(JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
$postman = $generator->toPostman(JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
$yaml = $generator->toYaml();
file_put_contents("files/json/$filename.json", $json);
file_put_contents("files/postman/$filename.json", $postman);
file_put_contents("files/yaml/$filename.yaml", $yaml);
}

73
files/v1.0.json → files/json/v100.json
View File

@ -9,6 +9,7 @@
"types": [
"int"
],
"optional": false,
"description": "The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order."
},
{
@ -16,6 +17,7 @@
"types": [
"Message"
],
"optional": true,
"description": "Optional. New incoming message of any kind — text, photo, sticker, etc."
}
]
@ -29,6 +31,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique identifier for this user or bot"
},
{
@ -36,6 +39,7 @@
"types": [
"string"
],
"optional": false,
"description": "User‘s or bot’s first name"
},
{
@ -43,6 +47,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. User‘s or bot’s last name"
},
{
@ -50,6 +55,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. User‘s or bot’s username"
}
]
@ -63,6 +69,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique identifier for this group chat"
},
{
@ -70,6 +77,7 @@
"types": [
"string"
],
"optional": false,
"description": "Group name"
}
]
@ -83,6 +91,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique message identifier"
},
{
@ -90,6 +99,7 @@
"types": [
"User"
],
"optional": false,
"description": "Sender"
},
{
@ -97,6 +107,7 @@
"types": [
"int"
],
"optional": false,
"description": "Date the message was sent in Unix time"
},
{
@ -105,6 +116,7 @@
"User",
"GroupChat"
],
"optional": false,
"description": "Conversation the message belongs to — user in case of a private message, GroupChat in case of a group"
},
{
@ -112,6 +124,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. For forwarded messages, sender of the original message"
},
{
@ -119,6 +132,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. For forwarded messages, date the original message was sent in Unix time"
},
{
@ -126,6 +140,7 @@
"types": [
"Message"
],
"optional": true,
"description": "Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply."
},
{
@ -133,6 +148,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. For text messages, the actual UTF-8 text of the message"
},
{
@ -140,6 +156,7 @@
"types": [
"Audio"
],
"optional": true,
"description": "Optional. Message is an audio file, information about the file"
},
{
@ -147,6 +164,7 @@
"types": [
"Document"
],
"optional": true,
"description": "Optional. Message is a general file, information about the file"
},
{
@ -154,6 +172,7 @@
"types": [
"Array<PhotoSize>"
],
"optional": true,
"description": "Optional. Message is a photo, available sizes of the photo"
},
{
@ -161,6 +180,7 @@
"types": [
"Sticker"
],
"optional": true,
"description": "Optional. Message is a sticker, information about the sticker"
},
{
@ -168,6 +188,7 @@
"types": [
"Video"
],
"optional": true,
"description": "Optional. Message is a video, information about the video"
},
{
@ -175,6 +196,7 @@
"types": [
"Contact"
],
"optional": true,
"description": "Optional. Message is a shared contact, information about the contact"
},
{
@ -182,6 +204,7 @@
"types": [
"Location"
],
"optional": true,
"description": "Optional. Message is a shared location, information about the location"
},
{
@ -189,6 +212,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. A new member was added to the group, information about them (this member may be bot itself)"
},
{
@ -196,6 +220,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. A member was removed from the group, information about them (this member may be bot itself)"
},
{
@ -203,6 +228,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. A group title was changed to this value"
},
{
@ -210,6 +236,7 @@
"types": [
"Array<PhotoSize>"
],
"optional": true,
"description": "Optional. A group photo was change to this value"
},
{
@ -217,6 +244,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Informs that the group photo was deleted"
},
{
@ -224,6 +252,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Informs that the group has been created"
}
]
@ -237,6 +266,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -244,6 +274,7 @@
"types": [
"int"
],
"optional": false,
"description": "Photo width"
},
{
@ -251,6 +282,7 @@
"types": [
"int"
],
"optional": false,
"description": "Photo height"
},
{
@ -258,6 +290,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -271,6 +304,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -278,6 +312,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the audio in seconds as defined by sender"
},
{
@ -285,6 +320,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -292,6 +328,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -305,6 +342,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique file identifier"
},
{
@ -312,6 +350,7 @@
"types": [
"PhotoSize"
],
"optional": false,
"description": "Document thumbnail as defined by sender"
},
{
@ -319,6 +358,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Original filename as defined by sender"
},
{
@ -326,6 +366,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -333,6 +374,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -346,6 +388,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -353,6 +396,7 @@
"types": [
"int"
],
"optional": false,
"description": "Sticker width"
},
{
@ -360,6 +404,7 @@
"types": [
"int"
],
"optional": false,
"description": "Sticker height"
},
{
@ -367,6 +412,7 @@
"types": [
"PhotoSize"
],
"optional": false,
"description": "Sticker thumbnail in .webp or .jpg format"
},
{
@ -374,6 +420,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -387,6 +434,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -394,6 +442,7 @@
"types": [
"int"
],
"optional": false,
"description": "Video width as defined by sender"
},
{
@ -401,6 +450,7 @@
"types": [
"int"
],
"optional": false,
"description": "Video height as defined by sender"
},
{
@ -408,6 +458,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the video in seconds as defined by sender"
},
{
@ -415,6 +466,7 @@
"types": [
"PhotoSize"
],
"optional": false,
"description": "Video thumbnail"
},
{
@ -422,6 +474,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Mime type of a file as defined by sender"
},
{
@ -429,6 +482,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
},
{
@ -436,6 +490,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Text description of the video (usually empty)"
}
]
@ -449,6 +504,7 @@
"types": [
"string"
],
"optional": false,
"description": "Contact's phone number"
},
{
@ -456,6 +512,7 @@
"types": [
"string"
],
"optional": false,
"description": "Contact's first name"
},
{
@ -463,6 +520,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Contact's last name"
},
{
@ -470,6 +528,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Contact's user identifier in Telegram"
}
]
@ -483,6 +542,7 @@
"types": [
"float"
],
"optional": false,
"description": "Longitude as defined by sender"
},
{
@ -490,6 +550,7 @@
"types": [
"float"
],
"optional": false,
"description": "Latitude as defined by sender"
}
]
@ -503,6 +564,7 @@
"types": [
"int"
],
"optional": false,
"description": "Total number of profile pictures the target user has"
},
{
@ -510,6 +572,7 @@
"types": [
"Array<Array<PhotoSize>>"
],
"optional": false,
"description": "Requested profile pictures (in up to 4 sizes each)"
}
]
@ -523,6 +586,7 @@
"types": [
"Array<Array<string>>"
],
"optional": false,
"description": "Array of button rows, each represented by an Array of Strings"
},
{
@ -530,6 +594,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard."
},
{
@ -537,6 +602,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false."
},
{
@ -544,6 +610,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard."
}
]
@ -557,6 +624,7 @@
"types": [
"bool"
],
"optional": false,
"description": "Requests clients to hide the custom keyboard"
},
{
@ -564,6 +632,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to hide keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet."
}
]
@ -577,6 +646,7 @@
"types": [
"bool"
],
"optional": false,
"description": "Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'"
},
{
@ -584,6 +654,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message."
}
]
@ -625,7 +696,7 @@
}
],
"return_types": [
"Update[]"
"Array<Update>"
]
},
{

73
files/v1.1.json → files/json/v110.json
View File

@ -9,6 +9,7 @@
"types": [
"int"
],
"optional": false,
"description": "The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order."
},
{
@ -16,6 +17,7 @@
"types": [
"Message"
],
"optional": true,
"description": "Optional. New incoming message of any kind — text, photo, sticker, etc."
}
]
@ -29,6 +31,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique identifier for this user or bot"
},
{
@ -36,6 +39,7 @@
"types": [
"string"
],
"optional": false,
"description": "User‘s or bot’s first name"
},
{
@ -43,6 +47,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. User‘s or bot’s last name"
},
{
@ -50,6 +55,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. User‘s or bot’s username"
}
]
@ -63,6 +69,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique identifier for this group chat"
},
{
@ -70,6 +77,7 @@
"types": [
"string"
],
"optional": false,
"description": "Group name"
}
]
@ -83,6 +91,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique message identifier"
},
{
@ -90,6 +99,7 @@
"types": [
"User"
],
"optional": false,
"description": "Sender"
},
{
@ -97,6 +107,7 @@
"types": [
"int"
],
"optional": false,
"description": "Date the message was sent in Unix time"
},
{
@ -105,6 +116,7 @@
"User",
"GroupChat"
],
"optional": false,
"description": "Conversation the message belongs to — user in case of a private message, GroupChat in case of a group"
},
{
@ -112,6 +124,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. For forwarded messages, sender of the original message"
},
{
@ -119,6 +132,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. For forwarded messages, date the original message was sent in Unix time"
},
{
@ -126,6 +140,7 @@
"types": [
"Message"
],
"optional": true,
"description": "Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply."
},
{
@ -133,6 +148,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. For text messages, the actual UTF-8 text of the message"
},
{
@ -140,6 +156,7 @@
"types": [
"Audio"
],
"optional": true,
"description": "Optional. Message is an audio file, information about the file"
},
{
@ -147,6 +164,7 @@
"types": [
"Document"
],
"optional": true,
"description": "Optional. Message is a general file, information about the file"
},
{
@ -154,6 +172,7 @@
"types": [
"Array<PhotoSize>"
],
"optional": true,
"description": "Optional. Message is a photo, available sizes of the photo"
},
{
@ -161,6 +180,7 @@
"types": [
"Sticker"
],
"optional": true,
"description": "Optional. Message is a sticker, information about the sticker"
},
{
@ -168,6 +188,7 @@
"types": [
"Video"
],
"optional": true,
"description": "Optional. Message is a video, information about the video"
},
{
@ -175,6 +196,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Caption for the photo or video"
},
{
@ -182,6 +204,7 @@
"types": [
"Contact"
],
"optional": true,
"description": "Optional. Message is a shared contact, information about the contact"
},
{
@ -189,6 +212,7 @@
"types": [
"Location"
],
"optional": true,
"description": "Optional. Message is a shared location, information about the location"
},
{
@ -196,6 +220,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. A new member was added to the group, information about them (this member may be bot itself)"
},
{
@ -203,6 +228,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. A member was removed from the group, information about them (this member may be bot itself)"
},
{
@ -210,6 +236,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. A group title was changed to this value"
},
{
@ -217,6 +244,7 @@
"types": [
"Array<PhotoSize>"
],
"optional": true,
"description": "Optional. A group photo was change to this value"
},
{
@ -224,6 +252,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Informs that the group photo was deleted"
},
{
@ -231,6 +260,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Informs that the group has been created"
}
]
@ -244,6 +274,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -251,6 +282,7 @@
"types": [
"int"
],
"optional": false,
"description": "Photo width"
},
{
@ -258,6 +290,7 @@
"types": [
"int"
],
"optional": false,
"description": "Photo height"
},
{
@ -265,6 +298,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -278,6 +312,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -285,6 +320,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the audio in seconds as defined by sender"
},
{
@ -292,6 +328,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -299,6 +336,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -312,6 +350,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique file identifier"
},
{
@ -319,6 +358,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Document thumbnail as defined by sender"
},
{
@ -326,6 +366,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Original filename as defined by sender"
},
{
@ -333,6 +374,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -340,6 +382,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -353,6 +396,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -360,6 +404,7 @@
"types": [
"int"
],
"optional": false,
"description": "Sticker width"
},
{
@ -367,6 +412,7 @@
"types": [
"int"
],
"optional": false,
"description": "Sticker height"
},
{
@ -374,6 +420,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Sticker thumbnail in .webp or .jpg format"
},
{
@ -381,6 +428,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -394,6 +442,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -401,6 +450,7 @@
"types": [
"int"
],
"optional": false,
"description": "Video width as defined by sender"
},
{
@ -408,6 +458,7 @@
"types": [
"int"
],
"optional": false,
"description": "Video height as defined by sender"
},
{
@ -415,6 +466,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the video in seconds as defined by sender"
},
{
@ -422,6 +474,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Video thumbnail"
},
{
@ -429,6 +482,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Mime type of a file as defined by sender"
},
{
@ -436,6 +490,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -449,6 +504,7 @@
"types": [
"string"
],
"optional": false,
"description": "Contact's phone number"
},
{
@ -456,6 +512,7 @@
"types": [
"string"
],
"optional": false,
"description": "Contact's first name"
},
{
@ -463,6 +520,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Contact's last name"
},
{
@ -470,6 +528,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. Contact's user identifier in Telegram"
}
]
@ -483,6 +542,7 @@
"types": [
"float"
],
"optional": false,
"description": "Longitude as defined by sender"
},
{
@ -490,6 +550,7 @@
"types": [
"float"
],
"optional": false,
"description": "Latitude as defined by sender"
}
]
@ -503,6 +564,7 @@
"types": [
"int"
],
"optional": false,
"description": "Total number of profile pictures the target user has"
},
{
@ -510,6 +572,7 @@
"types": [
"Array<Array<PhotoSize>>"
],
"optional": false,
"description": "Requested profile pictures (in up to 4 sizes each)"
}
]
@ -523,6 +586,7 @@
"types": [
"Array<Array<string>>"
],
"optional": false,
"description": "Array of button rows, each represented by an Array of Strings"
},
{
@ -530,6 +594,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard."
},
{
@ -537,6 +602,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false."
},
{
@ -544,6 +610,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard."
}
]
@ -557,6 +624,7 @@
"types": [
"bool"
],
"optional": false,
"description": "Requests clients to hide the custom keyboard"
},
{
@ -564,6 +632,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to hide keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet."
}
]
@ -577,6 +646,7 @@
"types": [
"bool"
],
"optional": false,
"description": "Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'"
},
{
@ -584,6 +654,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message."
}
]
@ -625,7 +696,7 @@
}
],
"return_types": [
"Update[]"
"Array<Update>"
]
},
{

80
files/v1.4.json → files/json/v140.json
View File

@ -9,6 +9,7 @@
"types": [
"int"
],
"optional": false,
"description": "The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order."
},
{
@ -16,6 +17,7 @@
"types": [
"Message"
],
"optional": true,
"description": "Optional. New incoming message of any kind — text, photo, sticker, etc."
}
]
@ -29,6 +31,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique identifier for this user or bot"
},
{
@ -36,6 +39,7 @@
"types": [
"string"
],
"optional": false,
"description": "User‘s or bot’s first name"
},
{
@ -43,6 +47,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. User‘s or bot’s last name"
},
{
@ -50,6 +55,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. User‘s or bot’s username"
}
]
@ -63,6 +69,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique identifier for this group chat"
},
{
@ -70,6 +77,7 @@
"types": [
"string"
],
"optional": false,
"description": "Group name"
}
]
@ -83,6 +91,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique message identifier"
},
{
@ -90,6 +99,7 @@
"types": [
"User"
],
"optional": false,
"description": "Sender"
},
{
@ -97,6 +107,7 @@
"types": [
"int"
],
"optional": false,
"description": "Date the message was sent in Unix time"
},
{
@ -105,6 +116,7 @@
"User",
"GroupChat"
],
"optional": false,
"description": "Conversation the message belongs to — user in case of a private message, GroupChat in case of a group"
},
{
@ -112,6 +124,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. For forwarded messages, sender of the original message"
},
{
@ -119,6 +132,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. For forwarded messages, date the original message was sent in Unix time"
},
{
@ -126,6 +140,7 @@
"types": [
"Message"
],
"optional": true,
"description": "Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply."
},
{
@ -133,6 +148,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. For text messages, the actual UTF-8 text of the message"
},
{
@ -140,6 +156,7 @@
"types": [
"Audio"
],
"optional": true,
"description": "Optional. Message is an audio file, information about the file"
},
{
@ -147,6 +164,7 @@
"types": [
"Document"
],
"optional": true,
"description": "Optional. Message is a general file, information about the file"
},
{
@ -154,6 +172,7 @@
"types": [
"Array<PhotoSize>"
],
"optional": true,
"description": "Optional. Message is a photo, available sizes of the photo"
},
{
@ -161,6 +180,7 @@
"types": [
"Sticker"
],
"optional": true,
"description": "Optional. Message is a sticker, information about the sticker"
},
{
@ -168,6 +188,7 @@
"types": [
"Video"
],
"optional": true,
"description": "Optional. Message is a video, information about the video"
},
{
@ -175,6 +196,7 @@
"types": [
"Voice"
],
"optional": true,
"description": "Optional. Message is a voice message, information about the file"
},
{
@ -182,6 +204,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Caption for the photo or video"
},
{
@ -189,6 +212,7 @@
"types": [
"Contact"
],
"optional": true,
"description": "Optional. Message is a shared contact, information about the contact"
},
{
@ -196,6 +220,7 @@
"types": [
"Location"
],
"optional": true,
"description": "Optional. Message is a shared location, information about the location"
},
{
@ -203,6 +228,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. A new member was added to the group, information about them (this member may be bot itself)"
},
{
@ -210,6 +236,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. A member was removed from the group, information about them (this member may be bot itself)"
},
{
@ -217,6 +244,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. A group title was changed to this value"
},
{
@ -224,6 +252,7 @@
"types": [
"Array<PhotoSize>"
],
"optional": true,
"description": "Optional. A group photo was change to this value"
},
{
@ -231,6 +260,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Informs that the group photo was deleted"
},
{
@ -238,6 +268,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Informs that the group has been created"
}
]
@ -251,6 +282,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -258,6 +290,7 @@
"types": [
"int"
],
"optional": false,
"description": "Photo width"
},
{
@ -265,6 +298,7 @@
"types": [
"int"
],
"optional": false,
"description": "Photo height"
},
{
@ -272,6 +306,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -285,6 +320,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -292,6 +328,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the audio in seconds as defined by sender"
},
{
@ -299,6 +336,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Performer of the audio as defined by sender or by audio tags"
},
{
@ -306,6 +344,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Title of the audio as defined by sender or by audio tags"
},
{
@ -313,6 +352,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -320,6 +360,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -333,6 +374,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique file identifier"
},
{
@ -340,6 +382,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Document thumbnail as defined by sender"
},
{
@ -347,6 +390,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Original filename as defined by sender"
},
{
@ -354,6 +398,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -361,6 +406,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -374,6 +420,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -381,6 +428,7 @@
"types": [
"int"
],
"optional": false,
"description": "Sticker width"
},
{
@ -388,6 +436,7 @@
"types": [
"int"
],
"optional": false,
"description": "Sticker height"
},
{
@ -395,6 +444,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Sticker thumbnail in .webp or .jpg format"
},
{
@ -402,6 +452,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -415,6 +466,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -422,6 +474,7 @@
"types": [
"int"
],
"optional": false,
"description": "Video width as defined by sender"
},
{
@ -429,6 +482,7 @@
"types": [
"int"
],
"optional": false,
"description": "Video height as defined by sender"
},
{
@ -436,6 +490,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the video in seconds as defined by sender"
},
{
@ -443,6 +498,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Video thumbnail"
},
{
@ -450,6 +506,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Mime type of a file as defined by sender"
},
{
@ -457,6 +514,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -470,6 +528,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -477,6 +536,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the audio in seconds as defined by sender"
},
{
@ -484,6 +544,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -491,6 +552,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -504,6 +566,7 @@
"types": [
"string"
],
"optional": false,
"description": "Contact's phone number"
},
{
@ -511,6 +574,7 @@
"types": [
"string"
],
"optional": false,
"description": "Contact's first name"
},
{
@ -518,6 +582,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Contact's last name"
},
{
@ -525,6 +590,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. Contact's user identifier in Telegram"
}
]
@ -538,6 +604,7 @@
"types": [
"float"
],
"optional": false,
"description": "Longitude as defined by sender"
},
{
@ -545,6 +612,7 @@
"types": [
"float"
],
"optional": false,
"description": "Latitude as defined by sender"
}
]
@ -558,6 +626,7 @@
"types": [
"int"
],
"optional": false,
"description": "Total number of profile pictures the target user has"
},
{
@ -565,6 +634,7 @@
"types": [
"Array<Array<PhotoSize>>"
],
"optional": false,
"description": "Requested profile pictures (in up to 4 sizes each)"
}
]
@ -578,6 +648,7 @@
"types": [
"Array<Array<string>>"
],
"optional": false,
"description": "Array of button rows, each represented by an Array of Strings"
},
{
@ -585,6 +656,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard."
},
{
@ -592,6 +664,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false."
},
{
@ -599,6 +672,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard."
}
]
@ -612,6 +686,7 @@
"types": [
"bool"
],
"optional": false,
"description": "Requests clients to hide the custom keyboard"
},
{
@ -619,6 +694,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to hide keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet."
}
]
@ -632,6 +708,7 @@
"types": [
"bool"
],
"optional": false,
"description": "Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'"
},
{
@ -639,6 +716,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message."
}
]
@ -680,7 +758,7 @@
}
],
"return_types": [
"Update[]"
"Array<Update>"
]
},
{

83
files/v1.5.json → files/json/v150.json
View File

@ -9,6 +9,7 @@
"types": [
"int"
],
"optional": false,
"description": "The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order."
},
{
@ -16,6 +17,7 @@
"types": [
"Message"
],
"optional": true,
"description": "Optional. New incoming message of any kind — text, photo, sticker, etc."
}
]
@ -29,6 +31,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique identifier for this user or bot"
},
{
@ -36,6 +39,7 @@
"types": [
"string"
],
"optional": false,
"description": "User‘s or bot’s first name"
},
{
@ -43,6 +47,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. User‘s or bot’s last name"
},
{
@ -50,6 +55,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. User‘s or bot’s username"
}
]
@ -63,6 +69,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique identifier for this group chat"
},
{
@ -70,6 +77,7 @@
"types": [
"string"
],
"optional": false,
"description": "Group name"
}
]
@ -83,6 +91,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique message identifier"
},
{
@ -90,6 +99,7 @@
"types": [
"User"
],
"optional": false,
"description": "Sender"
},
{
@ -97,6 +107,7 @@
"types": [
"int"
],
"optional": false,
"description": "Date the message was sent in Unix time"
},
{
@ -105,6 +116,7 @@
"User",
"GroupChat"
],
"optional": false,
"description": "Conversation the message belongs to — user in case of a private message, GroupChat in case of a group"
},
{
@ -112,6 +124,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. For forwarded messages, sender of the original message"
},
{
@ -119,6 +132,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. For forwarded messages, date the original message was sent in Unix time"
},
{
@ -126,6 +140,7 @@
"types": [
"Message"
],
"optional": true,
"description": "Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply."
},
{
@ -133,6 +148,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. For text messages, the actual UTF-8 text of the message"
},
{
@ -140,6 +156,7 @@
"types": [
"Audio"
],
"optional": true,
"description": "Optional. Message is an audio file, information about the file"
},
{
@ -147,6 +164,7 @@
"types": [
"Document"
],
"optional": true,
"description": "Optional. Message is a general file, information about the file"
},
{
@ -154,6 +172,7 @@
"types": [
"Array<PhotoSize>"
],
"optional": true,
"description": "Optional. Message is a photo, available sizes of the photo"
},
{
@ -161,6 +180,7 @@
"types": [
"Sticker"
],
"optional": true,
"description": "Optional. Message is a sticker, information about the sticker"
},
{
@ -168,6 +188,7 @@
"types": [
"Video"
],
"optional": true,
"description": "Optional. Message is a video, information about the video"
},
{
@ -175,6 +196,7 @@
"types": [
"Voice"
],
"optional": true,
"description": "Optional. Message is a voice message, information about the file"
},
{
@ -182,6 +204,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Caption for the photo or video"
},
{
@ -189,6 +212,7 @@
"types": [
"Contact"
],
"optional": true,
"description": "Optional. Message is a shared contact, information about the contact"
},
{
@ -196,6 +220,7 @@
"types": [
"Location"
],
"optional": true,
"description": "Optional. Message is a shared location, information about the location"
},
{
@ -203,6 +228,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. A new member was added to the group, information about them (this member may be bot itself)"
},
{
@ -210,6 +236,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. A member was removed from the group, information about them (this member may be bot itself)"
},
{
@ -217,6 +244,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. A group title was changed to this value"
},
{
@ -224,6 +252,7 @@
"types": [
"Array<PhotoSize>"
],
"optional": true,
"description": "Optional. A group photo was change to this value"
},
{
@ -231,6 +260,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Informs that the group photo was deleted"
},
{
@ -238,6 +268,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Informs that the group has been created"
}
]
@ -251,6 +282,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -258,6 +290,7 @@
"types": [
"int"
],
"optional": false,
"description": "Photo width"
},
{
@ -265,6 +298,7 @@
"types": [
"int"
],
"optional": false,
"description": "Photo height"
},
{
@ -272,6 +306,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -285,6 +320,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -292,6 +328,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the audio in seconds as defined by sender"
},
{
@ -299,6 +336,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Performer of the audio as defined by sender or by audio tags"
},
{
@ -306,6 +344,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Title of the audio as defined by sender or by audio tags"
},
{
@ -313,6 +352,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -320,6 +360,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -333,6 +374,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique file identifier"
},
{
@ -340,6 +382,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Document thumbnail as defined by sender"
},
{
@ -347,6 +390,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Original filename as defined by sender"
},
{
@ -354,6 +398,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -361,6 +406,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -374,6 +420,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -381,6 +428,7 @@
"types": [
"int"
],
"optional": false,
"description": "Sticker width"
},
{
@ -388,6 +436,7 @@
"types": [
"int"
],
"optional": false,
"description": "Sticker height"
},
{
@ -395,6 +444,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Sticker thumbnail in .webp or .jpg format"
},
{
@ -402,6 +452,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -415,6 +466,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -422,6 +474,7 @@
"types": [
"int"
],
"optional": false,
"description": "Video width as defined by sender"
},
{
@ -429,6 +482,7 @@
"types": [
"int"
],
"optional": false,
"description": "Video height as defined by sender"
},
{
@ -436,6 +490,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the video in seconds as defined by sender"
},
{
@ -443,6 +498,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Video thumbnail"
},
{
@ -450,6 +506,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Mime type of a file as defined by sender"
},
{
@ -457,6 +514,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -470,6 +528,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -477,6 +536,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the audio in seconds as defined by sender"
},
{
@ -484,6 +544,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -491,6 +552,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -504,6 +566,7 @@
"types": [
"string"
],
"optional": false,
"description": "Contact's phone number"
},
{
@ -511,6 +574,7 @@
"types": [
"string"
],
"optional": false,
"description": "Contact's first name"
},
{
@ -518,6 +582,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Contact's last name"
},
{
@ -525,6 +590,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. Contact's user identifier in Telegram"
}
]
@ -538,6 +604,7 @@
"types": [
"float"
],
"optional": false,
"description": "Longitude as defined by sender"
},
{
@ -545,6 +612,7 @@
"types": [
"float"
],
"optional": false,
"description": "Latitude as defined by sender"
}
]
@ -558,6 +626,7 @@
"types": [
"int"
],
"optional": false,
"description": "Total number of profile pictures the target user has"
},
{
@ -565,6 +634,7 @@
"types": [
"Array<Array<PhotoSize>>"
],
"optional": false,
"description": "Requested profile pictures (in up to 4 sizes each)"
}
]
@ -578,6 +648,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -585,6 +656,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size, if known"
},
{
@ -592,6 +664,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file."
}
]
@ -605,6 +678,7 @@
"types": [
"Array<Array<string>>"
],
"optional": false,
"description": "Array of button rows, each represented by an Array of Strings"
},
{
@ -612,6 +686,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard."
},
{
@ -619,6 +694,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false."
},
{
@ -626,6 +702,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard."
}
]
@ -639,6 +716,7 @@
"types": [
"bool"
],
"optional": false,
"description": "Requests clients to hide the custom keyboard"
},
{
@ -646,6 +724,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to hide keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet."
}
]
@ -659,6 +738,7 @@
"types": [
"bool"
],
"optional": false,
"description": "Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'"
},
{
@ -666,6 +746,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message."
}
]
@ -707,7 +788,7 @@
}
],
"return_types": [
"Update[]"
"Array<Update>"
]
},
{

87
files/v1.6.json → files/json/v160.json
View File

@ -9,6 +9,7 @@
"types": [
"int"
],
"optional": false,
"description": "The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order."
},
{
@ -16,6 +17,7 @@
"types": [
"Message"
],
"optional": true,
"description": "Optional. New incoming message of any kind — text, photo, sticker, etc."
}
]
@ -29,6 +31,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique identifier for this user or bot"
},
{
@ -36,6 +39,7 @@
"types": [
"string"
],
"optional": false,
"description": "User‘s or bot’s first name"
},
{
@ -43,6 +47,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. User‘s or bot’s last name"
},
{
@ -50,6 +55,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. User‘s or bot’s username"
}
]
@ -63,6 +69,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique identifier for this chat, not exceeding 1e13 by absolute value"
},
{
@ -70,6 +77,7 @@
"types": [
"string"
],
"optional": false,
"description": "Type of chat, can be either “private”, or “group”, or “channel”"
},
{
@ -77,6 +85,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Title, for channels and group chats"
},
{
@ -84,6 +93,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Username, for private chats and channels if available"
},
{
@ -91,6 +101,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. First name of the other party in a private chat"
},
{
@ -98,6 +109,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Last name of the other party in a private chat"
}
]
@ -111,6 +123,7 @@
"types": [
"int"
],
"optional": false,
"description": "Unique message identifier"
},
{
@ -118,6 +131,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. Sender, can be empty for messages sent to channels"
},
{
@ -125,6 +139,7 @@
"types": [
"int"
],
"optional": false,
"description": "Date the message was sent in Unix time"
},
{
@ -132,6 +147,7 @@
"types": [
"Chat"
],
"optional": false,
"description": "Conversation the message belongs to"
},
{
@ -139,6 +155,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. For forwarded messages, sender of the original message"
},
{
@ -146,6 +163,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. For forwarded messages, date the original message was sent in Unix time"
},
{
@ -153,6 +171,7 @@
"types": [
"Message"
],
"optional": true,
"description": "Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply."
},
{
@ -160,6 +179,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. For text messages, the actual UTF-8 text of the message"
},
{
@ -167,6 +187,7 @@
"types": [
"Audio"
],
"optional": true,
"description": "Optional. Message is an audio file, information about the file"
},
{
@ -174,6 +195,7 @@
"types": [
"Document"
],
"optional": true,
"description": "Optional. Message is a general file, information about the file"
},
{
@ -181,6 +203,7 @@
"types": [
"Array<PhotoSize>"
],
"optional": true,
"description": "Optional. Message is a photo, available sizes of the photo"
},
{
@ -188,6 +211,7 @@
"types": [
"Sticker"
],
"optional": true,
"description": "Optional. Message is a sticker, information about the sticker"
},
{
@ -195,6 +219,7 @@
"types": [
"Video"
],
"optional": true,
"description": "Optional. Message is a video, information about the video"
},
{
@ -202,6 +227,7 @@
"types": [
"Voice"
],
"optional": true,
"description": "Optional. Message is a voice message, information about the file"
},
{
@ -209,6 +235,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Caption for the photo or video"
},
{
@ -216,6 +243,7 @@
"types": [
"Contact"
],
"optional": true,
"description": "Optional. Message is a shared contact, information about the contact"
},
{
@ -223,6 +251,7 @@
"types": [
"Location"
],
"optional": true,
"description": "Optional. Message is a shared location, information about the location"
},
{
@ -230,6 +259,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. A new member was added to the group, information about them (this member may be bot itself)"
},
{
@ -237,6 +267,7 @@
"types": [
"User"
],
"optional": true,
"description": "Optional. A member was removed from the group, information about them (this member may be bot itself)"
},
{
@ -244,6 +275,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. A chat title was changed to this value"
},
{
@ -251,6 +283,7 @@
"types": [
"Array<PhotoSize>"
],
"optional": true,
"description": "Optional. A chat photo was change to this value"
},
{
@ -258,6 +291,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Informs that the chat photo was deleted"
},
{
@ -265,6 +299,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Informs that the group has been created"
}
]
@ -278,6 +313,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -285,6 +321,7 @@
"types": [
"int"
],
"optional": false,
"description": "Photo width"
},
{
@ -292,6 +329,7 @@
"types": [
"int"
],
"optional": false,
"description": "Photo height"
},
{
@ -299,6 +337,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -312,6 +351,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -319,6 +359,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the audio in seconds as defined by sender"
},
{
@ -326,6 +367,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Performer of the audio as defined by sender or by audio tags"
},
{
@ -333,6 +375,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Title of the audio as defined by sender or by audio tags"
},
{
@ -340,6 +383,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -347,6 +391,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -360,6 +405,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique file identifier"
},
{
@ -367,6 +413,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Document thumbnail as defined by sender"
},
{
@ -374,6 +421,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Original filename as defined by sender"
},
{
@ -381,6 +429,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -388,6 +437,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -401,6 +451,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -408,6 +459,7 @@
"types": [
"int"
],
"optional": false,
"description": "Sticker width"
},
{
@ -415,6 +467,7 @@
"types": [
"int"
],
"optional": false,
"description": "Sticker height"
},
{
@ -422,6 +475,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Sticker thumbnail in .webp or .jpg format"
},
{
@ -429,6 +483,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -442,6 +497,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -449,6 +505,7 @@
"types": [
"int"
],
"optional": false,
"description": "Video width as defined by sender"
},
{
@ -456,6 +513,7 @@
"types": [
"int"
],
"optional": false,
"description": "Video height as defined by sender"
},
{
@ -463,6 +521,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the video in seconds as defined by sender"
},
{
@ -470,6 +529,7 @@
"types": [
"PhotoSize"
],
"optional": true,
"description": "Optional. Video thumbnail"
},
{
@ -477,6 +537,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Mime type of a file as defined by sender"
},
{
@ -484,6 +545,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -497,6 +559,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -504,6 +567,7 @@
"types": [
"int"
],
"optional": false,
"description": "Duration of the audio in seconds as defined by sender"
},
{
@ -511,6 +575,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. MIME type of the file as defined by sender"
},
{
@ -518,6 +583,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size"
}
]
@ -531,6 +597,7 @@
"types": [
"string"
],
"optional": false,
"description": "Contact's phone number"
},
{
@ -538,6 +605,7 @@
"types": [
"string"
],
"optional": false,
"description": "Contact's first name"
},
{
@ -545,6 +613,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. Contact's last name"
},
{
@ -552,6 +621,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. Contact's user identifier in Telegram"
}
]
@ -565,6 +635,7 @@
"types": [
"float"
],
"optional": false,
"description": "Longitude as defined by sender"
},
{
@ -572,6 +643,7 @@
"types": [
"float"
],
"optional": false,
"description": "Latitude as defined by sender"
}
]
@ -585,6 +657,7 @@
"types": [
"int"
],
"optional": false,
"description": "Total number of profile pictures the target user has"
},
{
@ -592,6 +665,7 @@
"types": [
"Array<Array<PhotoSize>>"
],
"optional": false,
"description": "Requested profile pictures (in up to 4 sizes each)"
}
]
@ -605,6 +679,7 @@
"types": [
"string"
],
"optional": false,
"description": "Unique identifier for this file"
},
{
@ -612,6 +687,7 @@
"types": [
"int"
],
"optional": true,
"description": "Optional. File size, if known"
},
{
@ -619,6 +695,7 @@
"types": [
"string"
],
"optional": true,
"description": "Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file."
}
]
@ -632,6 +709,7 @@
"types": [
"Array<Array<string>>"
],
"optional": false,
"description": "Array of button rows, each represented by an Array of Strings"
},
{
@ -639,6 +717,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard."
},
{
@ -646,6 +725,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false."
},
{
@ -653,6 +733,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard."
}
]
@ -666,6 +747,7 @@
"types": [
"bool"
],
"optional": false,
"description": "Requests clients to hide the custom keyboard"
},
{
@ -673,6 +755,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to hide keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet."
}
]
@ -686,6 +769,7 @@
"types": [
"bool"
],
"optional": false,
"description": "Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'"
},
{
@ -693,6 +777,7 @@
"types": [
"bool"
],
"optional": true,
"description": "Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message."
}
]
@ -734,7 +819,7 @@
}
],
"return_types": [
"Update[]"
"Array<Update>"
]
},
{

155
files/v1.8.json → files/json/v180.json
View File

File diff suppressed because it is too large Load Diff

159
files/v1.8.2.json → files/json/v182.json
View File

File diff suppressed because it is too large Load Diff

159
files/v1.8.3.json → files/json/v183.json
View File

File diff suppressed because it is too large Load Diff

309
files/v2.0.json → files/json/v200.json
View File

File diff suppressed because it is too large Load Diff

318
files/v2.1.json → files/json/v210.json
View File

File diff suppressed because it is too large Load Diff

4105
files/json/v211.json Normal file
View File

File diff suppressed because it is too large Load Diff

355
files/v2.2.json → files/json/v220.json
View File

File diff suppressed because it is too large Load Diff

358
files/v2.3.json → files/json/v230.json
View File

File diff suppressed because it is too large Load Diff

360
files/v2.3.1.json → files/json/v231.json
View File

File diff suppressed because it is too large Load Diff

413
files/v3.0.json → files/json/v300.json
View File

File diff suppressed because it is too large Load Diff

432
files/v3.1.json → files/json/v310.json
View File

File diff suppressed because it is too large Load Diff

442
files/v3.2.json → files/json/v320.json
View File

File diff suppressed because it is too large Load Diff

445
files/v3.3.json → files/json/v330.json
View File

File diff suppressed because it is too large Load Diff

462
files/v3.5.json → files/json/v350.json
View File

File diff suppressed because it is too large Load Diff

486
files/v3.6.json → files/json/v360.json
View File

File diff suppressed because it is too large Load Diff

555
files/v4.0.json → files/json/v400.json
View File

File diff suppressed because it is too large Load Diff

569
files/v4.1.json → files/json/v410.json
View File

File diff suppressed because it is too large Load Diff

627
files/v4.3.json → files/json/v420.json
View File

File diff suppressed because it is too large Load Diff

633
files/v4.2.json → files/json/v430.json
View File

File diff suppressed because it is too large Load Diff

596
files/v4.4.json → files/json/v440.json
View File

File diff suppressed because it is too large Load Diff

610
files/v4.5.json → files/json/v450.json
View File

File diff suppressed because it is too large Load Diff

625
files/v4.6.json → files/json/v460.json
View File

File diff suppressed because it is too large Load Diff

632
files/v4.7.json → files/json/v470.json
View File

File diff suppressed because it is too large Load Diff

637
files/v4.8.json → files/json/v480.json
View File

File diff suppressed because it is too large Load Diff

640
files/v4.9.json → files/json/v490.json
View File

File diff suppressed because it is too large Load Diff

692
files/v5.0.json → files/json/v500.json
View File

File diff suppressed because it is too large Load Diff

716
files/v5.1.json → files/json/v510.json
View File

File diff suppressed because it is too large Load Diff

739
files/v5.2.json → files/json/v520.json
View File

File diff suppressed because it is too large Load Diff

0
files/v5.3.json → files/json/v530.json
View File

595
files/postman/v100.json Normal file
View File

@ -0,0 +1,595 @@
{
"info": {
"name": "Telegram Bot API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"variable": {
"key": "token",
"value": "1234:AAbbcc",
"type": "string"
},
"item": [
{
"name": "getUpdates",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "offset",
"value": "",
"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",
"value": "",
"description": "Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100",
"type": "text"
},
{
"key": "timeout",
"value": "",
"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": "url",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "text",
"value": "",
"description": "Required. Text of the message to be sent",
"type": "text"
},
{
"key": "disable_web_page_preview",
"value": "",
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "from_chat_id",
"value": "",
"description": "Required. Unique identifier for the chat where the original message was sent — User or GroupChat id",
"type": "text"
},
{
"key": "message_id",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "photo",
"value": "",
"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",
"value": "",
"description": "Optional. Photo caption (may also be used when resending photos by file_id).",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "audio",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "document",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "sticker",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "video",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "latitude",
"value": "",
"description": "Required. Latitude of location",
"type": "text"
},
{
"key": "longitude",
"value": "",
"description": "Required. Longitude of location",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "action",
"value": "",
"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": "user_id",
"value": "",
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "offset",
"value": "",
"description": "Optional. Sequential number of the first photo to be returned. By default, all photos are returned.",
"type": "text"
},
{
"key": "limit",
"value": "",
"description": "Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text"
}
]
},
"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."
}
}
]
}

613
files/postman/v110.json Normal file
View File

@ -0,0 +1,613 @@
{
"info": {
"name": "Telegram Bot API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"variable": {
"key": "token",
"value": "1234:AAbbcc",
"type": "string"
},
"item": [
{
"name": "getUpdates",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "offset",
"value": "",
"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",
"value": "",
"description": "Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100",
"type": "text"
},
{
"key": "timeout",
"value": "",
"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": "url",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "text",
"value": "",
"description": "Required. Text of the message to be sent",
"type": "text"
},
{
"key": "disable_web_page_preview",
"value": "",
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "from_chat_id",
"value": "",
"description": "Required. Unique identifier for the chat where the original message was sent — User or GroupChat id",
"type": "text"
},
{
"key": "message_id",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "photo",
"value": "",
"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",
"value": "",
"description": "Optional. Photo caption (may also be used when resending photos by file_id).",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "audio",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent audio in seconds",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "document",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "sticker",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "video",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent video in seconds",
"type": "text"
},
{
"key": "caption",
"value": "",
"description": "Optional. Video caption (may also be used when resending videos by file_id).",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "latitude",
"value": "",
"description": "Required. Latitude of location",
"type": "text"
},
{
"key": "longitude",
"value": "",
"description": "Required. Longitude of location",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "action",
"value": "",
"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": "user_id",
"value": "",
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "offset",
"value": "",
"description": "Optional. Sequential number of the first photo to be returned. By default, all photos are returned.",
"type": "text"
},
{
"key": "limit",
"value": "",
"description": "Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text"
}
]
},
"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."
}
}
]
}

692
files/postman/v140.json Normal file
View File

@ -0,0 +1,692 @@
{
"info": {
"name": "Telegram Bot API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"variable": {
"key": "token",
"value": "1234:AAbbcc",
"type": "string"
},
"item": [
{
"name": "getUpdates",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "offset",
"value": "",
"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",
"value": "",
"description": "Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100",
"type": "text"
},
{
"key": "timeout",
"value": "",
"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": "url",
"value": "",
"description": "Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration",
"type": "text"
},
{
"key": "certificate",
"value": "",
"description": "Optional. Upload your public key certificate so that the root certificate in use can be checked",
"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. https://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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "text",
"value": "",
"description": "Required. Text of the message to be sent",
"type": "text"
},
{
"key": "parse_mode",
"value": "",
"description": "Optional. Send Markdown, if you want Telegram apps to show bold, italic and inline URLs in your bot's message. For the moment, only Telegram for Android supports this.",
"type": "text"
},
{
"key": "disable_web_page_preview",
"value": "",
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "from_chat_id",
"value": "",
"description": "Required. Unique identifier for the chat where the original message was sent — User or GroupChat id",
"type": "text"
},
{
"key": "message_id",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "photo",
"value": "",
"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",
"value": "",
"description": "Optional. Photo caption (may also be used when resending photos by file_id).",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "audio",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of the audio in seconds",
"type": "text"
},
{
"key": "performer",
"value": "",
"description": "Optional. Performer",
"type": "text"
},
{
"key": "title",
"value": "",
"description": "Optional. Track name",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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 them in the music player. Your audio must be in the .mp3 format. 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.\nFor backward compatibility, when the fields title and performer are both empty and the mime-type of the file to be sent is not audio/mpeg, the file will be sent as a playable voice message. For this to work, the audio must be in an .ogg file encoded with OPUS. This behavior will be phased out in the future. For sending voice messages, use the sendVoice method instead."
}
},
{
"name": "sendDocument",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "document",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "sticker",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "video",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent video in seconds",
"type": "text"
},
{
"key": "caption",
"value": "",
"description": "Optional. Video caption (may also be used when resending videos by file_id).",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "sendVoice",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "voice",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent audio in seconds",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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}}/sendVoice",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVoice"
]
},
"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 Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages 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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "latitude",
"value": "",
"description": "Required. Latitude of location",
"type": "text"
},
{
"key": "longitude",
"value": "",
"description": "Required. Longitude of location",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "action",
"value": "",
"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": "user_id",
"value": "",
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "offset",
"value": "",
"description": "Optional. Sequential number of the first photo to be returned. By default, all photos are returned.",
"type": "text"
},
{
"key": "limit",
"value": "",
"description": "Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text"
}
]
},
"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."
}
}
]
}

723
files/postman/v150.json Normal file
View File

@ -0,0 +1,723 @@
{
"info": {
"name": "Telegram Bot API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"variable": {
"key": "token",
"value": "1234:AAbbcc",
"type": "string"
},
"item": [
{
"name": "getUpdates",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "offset",
"value": "",
"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",
"value": "",
"description": "Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100",
"type": "text"
},
{
"key": "timeout",
"value": "",
"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": "url",
"value": "",
"description": "Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration",
"type": "text"
},
{
"key": "certificate",
"value": "",
"description": "Optional. Upload your public key certificate so that the root certificate in use can be checked",
"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. https://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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "text",
"value": "",
"description": "Required. Text of the message to be sent",
"type": "text"
},
{
"key": "parse_mode",
"value": "",
"description": "Optional. Send Markdown, if you want Telegram apps to show bold, italic and inline URLs in your bot's message. For the moment, only Telegram for Android supports this.",
"type": "text"
},
{
"key": "disable_web_page_preview",
"value": "",
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "from_chat_id",
"value": "",
"description": "Required. Unique identifier for the chat where the original message was sent — User or GroupChat id",
"type": "text"
},
{
"key": "message_id",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "photo",
"value": "",
"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",
"value": "",
"description": "Optional. Photo caption (may also be used when resending photos by file_id).",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "audio",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of the audio in seconds",
"type": "text"
},
{
"key": "performer",
"value": "",
"description": "Optional. Performer",
"type": "text"
},
{
"key": "title",
"value": "",
"description": "Optional. Track name",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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 them in the music player. Your audio must be in the .mp3 format. 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.\nFor backward compatibility, when the fields title and performer are both empty and the mime-type of the file to be sent is not audio/mpeg, the file will be sent as a playable voice message. For this to work, the audio must be in an .ogg file encoded with OPUS. This behavior will be phased out in the future. For sending voice messages, use the sendVoice method instead."
}
},
{
"name": "sendDocument",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "document",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "sticker",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "video",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent video in seconds",
"type": "text"
},
{
"key": "caption",
"value": "",
"description": "Optional. Video caption (may also be used when resending videos by file_id).",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "sendVoice",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "voice",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent audio in seconds",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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}}/sendVoice",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVoice"
]
},
"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 Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages 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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "latitude",
"value": "",
"description": "Required. Latitude of location",
"type": "text"
},
{
"key": "longitude",
"value": "",
"description": "Required. Longitude of location",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the message recipient — User or GroupChat id",
"type": "text"
},
{
"key": "action",
"value": "",
"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": "user_id",
"value": "",
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "offset",
"value": "",
"description": "Optional. Sequential number of the first photo to be returned. By default, all photos are returned.",
"type": "text"
},
{
"key": "limit",
"value": "",
"description": "Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text"
}
]
},
"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."
}
},
{
"name": "getFile",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file_id",
"value": "",
"description": "Required. File identifier to get info about",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getFile",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getFile"
]
},
"description": "Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again."
}
}
]
}

723
files/postman/v160.json Normal file
View File

@ -0,0 +1,723 @@
{
"info": {
"name": "Telegram Bot API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"variable": {
"key": "token",
"value": "1234:AAbbcc",
"type": "string"
},
"item": [
{
"name": "getUpdates",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "offset",
"value": "",
"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",
"value": "",
"description": "Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100",
"type": "text"
},
{
"key": "timeout",
"value": "",
"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": "url",
"value": "",
"description": "Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration",
"type": "text"
},
{
"key": "certificate",
"value": "",
"description": "Optional. Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.",
"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. https://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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "text",
"value": "",
"description": "Required. Text of the message to be sent",
"type": "text"
},
{
"key": "parse_mode",
"value": "",
"description": "Optional. Send Markdown, if you want Telegram apps to show bold, italic and inline URLs in your bot's message. For the moment, only Telegram for Android supports this.",
"type": "text"
},
{
"key": "disable_web_page_preview",
"value": "",
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "from_chat_id",
"value": "",
"description": "Required. Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "photo",
"value": "",
"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",
"value": "",
"description": "Optional. Photo caption (may also be used when resending photos by file_id).",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "audio",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of the audio in seconds",
"type": "text"
},
{
"key": "performer",
"value": "",
"description": "Optional. Performer",
"type": "text"
},
{
"key": "title",
"value": "",
"description": "Optional. Track name",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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 them in the music player. Your audio must be in the .mp3 format. 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.\nFor backward compatibility, when the fields title and performer are both empty and the mime-type of the file to be sent is not audio/mpeg, the file will be sent as a playable voice message. For this to work, the audio must be in an .ogg file encoded with OPUS. This behavior will be phased out in the future. For sending voice messages, use the sendVoice method instead."
}
},
{
"name": "sendDocument",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "document",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "sticker",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "video",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent video in seconds",
"type": "text"
},
{
"key": "caption",
"value": "",
"description": "Optional. Video caption (may also be used when resending videos by file_id).",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "sendVoice",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "voice",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent audio in seconds",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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}}/sendVoice",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVoice"
]
},
"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 Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages 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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "latitude",
"value": "",
"description": "Required. Latitude of location",
"type": "text"
},
{
"key": "longitude",
"value": "",
"description": "Required. Longitude of location",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "action",
"value": "",
"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": "user_id",
"value": "",
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "offset",
"value": "",
"description": "Optional. Sequential number of the first photo to be returned. By default, all photos are returned.",
"type": "text"
},
{
"key": "limit",
"value": "",
"description": "Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text"
}
]
},
"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."
}
},
{
"name": "getFile",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file_id",
"value": "",
"description": "Required. File identifier to get info about",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getFile",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getFile"
]
},
"description": "Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again."
}
}
]
}

778
files/postman/v180.json Normal file
View File

@ -0,0 +1,778 @@
{
"info": {
"name": "Telegram Bot API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"variable": {
"key": "token",
"value": "1234:AAbbcc",
"type": "string"
},
"item": [
{
"name": "getUpdates",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "offset",
"value": "",
"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",
"value": "",
"description": "Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100",
"type": "text"
},
{
"key": "timeout",
"value": "",
"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": "url",
"value": "",
"description": "Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration",
"type": "text"
},
{
"key": "certificate",
"value": "",
"description": "Optional. Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.",
"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. https://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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "text",
"value": "",
"description": "Required. Text of the message to be sent",
"type": "text"
},
{
"key": "parse_mode",
"value": "",
"description": "Optional. Send Markdown, if you want Telegram apps to show bold, italic and inline URLs in your bot's message.",
"type": "text"
},
{
"key": "disable_web_page_preview",
"value": "",
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "from_chat_id",
"value": "",
"description": "Required. Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "photo",
"value": "",
"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",
"value": "",
"description": "Optional. Photo caption (may also be used when resending photos by file_id), 0-200 characters.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "audio",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of the audio in seconds",
"type": "text"
},
{
"key": "performer",
"value": "",
"description": "Optional. Performer",
"type": "text"
},
{
"key": "title",
"value": "",
"description": "Optional. Track name",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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 them in the music player. Your audio must be in the .mp3 format. 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.\nFor backward compatibility, when the fields title and performer are both empty and the mime-type of the file to be sent is not audio/mpeg, the file will be sent as a playable voice message. For this to work, the audio must be in an .ogg file encoded with OPUS. This behavior will be phased out in the future. For sending voice messages, use the sendVoice method instead."
}
},
{
"name": "sendDocument",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "document",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "sticker",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "video",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent video in seconds",
"type": "text"
},
{
"key": "caption",
"value": "",
"description": "Optional. Video caption (may also be used when resending videos by file_id), 0-200 characters.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "sendVoice",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "voice",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent audio in seconds",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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}}/sendVoice",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVoice"
]
},
"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 Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages 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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "latitude",
"value": "",
"description": "Required. Latitude of location",
"type": "text"
},
{
"key": "longitude",
"value": "",
"description": "Required. Longitude of location",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "action",
"value": "",
"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": "user_id",
"value": "",
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "offset",
"value": "",
"description": "Optional. Sequential number of the first photo to be returned. By default, all photos are returned.",
"type": "text"
},
{
"key": "limit",
"value": "",
"description": "Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text"
}
]
},
"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."
}
},
{
"name": "getFile",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file_id",
"value": "",
"description": "Required. File identifier to get info about",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getFile",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getFile"
]
},
"description": "Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again."
}
},
{
"name": "answerInlineQuery",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "inline_query_id",
"value": "",
"description": "Required. Unique identifier for the answered query",
"type": "text"
},
{
"key": "results",
"value": "",
"description": "Required. A JSON-serialized array of results for the inline query",
"type": "text"
},
{
"key": "cache_time",
"value": "",
"description": "Optional. The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.",
"type": "text"
},
{
"key": "is_personal",
"value": "",
"description": "Optional. Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query",
"type": "text"
},
{
"key": "next_offset",
"value": "",
"description": "Optional. Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/answerInlineQuery",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"answerInlineQuery"
]
},
"description": "Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed."
}
}
]
}

778
files/postman/v182.json Normal file
View File

@ -0,0 +1,778 @@
{
"info": {
"name": "Telegram Bot API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"variable": {
"key": "token",
"value": "1234:AAbbcc",
"type": "string"
},
"item": [
{
"name": "getUpdates",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "offset",
"value": "",
"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",
"value": "",
"description": "Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100",
"type": "text"
},
{
"key": "timeout",
"value": "",
"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": "url",
"value": "",
"description": "Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration",
"type": "text"
},
{
"key": "certificate",
"value": "",
"description": "Optional. Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.",
"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. https://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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "text",
"value": "",
"description": "Required. Text of the message to be sent",
"type": "text"
},
{
"key": "parse_mode",
"value": "",
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.",
"type": "text"
},
{
"key": "disable_web_page_preview",
"value": "",
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "from_chat_id",
"value": "",
"description": "Required. Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)",
"type": "text"
},
{
"key": "message_id",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "photo",
"value": "",
"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",
"value": "",
"description": "Optional. Photo caption (may also be used when resending photos by file_id), 0-200 characters.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "audio",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of the audio in seconds",
"type": "text"
},
{
"key": "performer",
"value": "",
"description": "Optional. Performer",
"type": "text"
},
{
"key": "title",
"value": "",
"description": "Optional. Track name",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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 them in the music player. Your audio must be in the .mp3 format. 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.\nFor backward compatibility, when the fields title and performer are both empty and the mime-type of the file to be sent is not audio/mpeg, the file will be sent as a playable voice message. For this to work, the audio must be in an .ogg file encoded with OPUS. This behavior will be phased out in the future. For sending voice messages, use the sendVoice method instead."
}
},
{
"name": "sendDocument",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "document",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "sticker",
"value": "",
"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",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "video",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent video in seconds",
"type": "text"
},
{
"key": "caption",
"value": "",
"description": "Optional. Video caption (may also be used when resending videos by file_id), 0-200 characters.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "sendVoice",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "voice",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent audio in seconds",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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}}/sendVoice",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVoice"
]
},
"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 Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages 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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "latitude",
"value": "",
"description": "Required. Latitude of location",
"type": "text"
},
{
"key": "longitude",
"value": "",
"description": "Required. Longitude of location",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "action",
"value": "",
"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": "user_id",
"value": "",
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "offset",
"value": "",
"description": "Optional. Sequential number of the first photo to be returned. By default, all photos are returned.",
"type": "text"
},
{
"key": "limit",
"value": "",
"description": "Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text"
}
]
},
"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."
}
},
{
"name": "getFile",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file_id",
"value": "",
"description": "Required. File identifier to get info about",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getFile",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getFile"
]
},
"description": "Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again."
}
},
{
"name": "answerInlineQuery",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "inline_query_id",
"value": "",
"description": "Required. Unique identifier for the answered query",
"type": "text"
},
{
"key": "results",
"value": "",
"description": "Required. A JSON-serialized array of results for the inline query",
"type": "text"
},
{
"key": "cache_time",
"value": "",
"description": "Optional. The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.",
"type": "text"
},
{
"key": "is_personal",
"value": "",
"description": "Optional. Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query",
"type": "text"
},
{
"key": "next_offset",
"value": "",
"description": "Optional. Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/answerInlineQuery",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"answerInlineQuery"
]
},
"description": "Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed."
}
}
]
}

850
files/postman/v183.json Normal file
View File

@ -0,0 +1,850 @@
{
"info": {
"name": "Telegram Bot API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"variable": {
"key": "token",
"value": "1234:AAbbcc",
"type": "string"
},
"item": [
{
"name": "getUpdates",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "offset",
"value": "",
"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. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.",
"type": "text"
},
{
"key": "limit",
"value": "",
"description": "Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text"
},
{
"key": "timeout",
"value": "",
"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": "url",
"value": "",
"description": "Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration",
"type": "text"
},
{
"key": "certificate",
"value": "",
"description": "Optional. Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.",
"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. https://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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "text",
"value": "",
"description": "Required. Text of the message to be sent",
"type": "text"
},
{
"key": "parse_mode",
"value": "",
"description": "Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.",
"type": "text"
},
{
"key": "disable_web_page_preview",
"value": "",
"description": "Optional. Disables link previews for links in this message",
"type": "text"
},
{
"key": "disable_notification",
"value": "",
"description": "Optional. Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "from_chat_id",
"value": "",
"description": "Required. Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)",
"type": "text"
},
{
"key": "disable_notification",
"value": "",
"description": "Optional. Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.",
"type": "text"
},
{
"key": "message_id",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "photo",
"value": "",
"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",
"value": "",
"description": "Optional. Photo caption (may also be used when resending photos by file_id), 0-200 characters",
"type": "text"
},
{
"key": "disable_notification",
"value": "",
"description": "Optional. Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "audio",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of the audio in seconds",
"type": "text"
},
{
"key": "performer",
"value": "",
"description": "Optional. Performer",
"type": "text"
},
{
"key": "title",
"value": "",
"description": "Optional. Track name",
"type": "text"
},
{
"key": "disable_notification",
"value": "",
"description": "Optional. Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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 them in the music player. Your audio must be in the .mp3 format. 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.\nFor sending voice messages, use the sendVoice method instead."
}
},
{
"name": "sendDocument",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "document",
"value": "",
"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": "caption",
"value": "",
"description": "Optional. Document caption (may also be used when resending documents by file_id), 0-200 characters",
"type": "text"
},
{
"key": "disable_notification",
"value": "",
"description": "Optional. Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "sticker",
"value": "",
"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": "disable_notification",
"value": "",
"description": "Optional. Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "video",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent video in seconds",
"type": "text"
},
{
"key": "width",
"value": "",
"description": "Optional. Video width",
"type": "text"
},
{
"key": "height",
"value": "",
"description": "Optional. Video height",
"type": "text"
},
{
"key": "caption",
"value": "",
"description": "Optional. Video caption (may also be used when resending videos by file_id), 0-200 characters",
"type": "text"
},
{
"key": "disable_notification",
"value": "",
"description": "Optional. Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "sendVoice",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "voice",
"value": "",
"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": "duration",
"value": "",
"description": "Optional. Duration of sent audio in seconds",
"type": "text"
},
{
"key": "disable_notification",
"value": "",
"description": "Optional. Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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}}/sendVoice",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"sendVoice"
]
},
"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 Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages 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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "latitude",
"value": "",
"description": "Required. Latitude of location",
"type": "text"
},
{
"key": "longitude",
"value": "",
"description": "Required. Longitude of location",
"type": "text"
},
{
"key": "disable_notification",
"value": "",
"description": "Optional. Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.",
"type": "text"
},
{
"key": "reply_to_message_id",
"value": "",
"description": "Optional. If the message is a reply, ID of the original message",
"type": "text"
},
{
"key": "reply_markup",
"value": "",
"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": "chat_id",
"value": "",
"description": "Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type": "text"
},
{
"key": "action",
"value": "",
"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": "user_id",
"value": "",
"description": "Required. Unique identifier of the target user",
"type": "text"
},
{
"key": "offset",
"value": "",
"description": "Optional. Sequential number of the first photo to be returned. By default, all photos are returned.",
"type": "text"
},
{
"key": "limit",
"value": "",
"description": "Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.",
"type": "text"
}
]
},
"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."
}
},
{
"name": "getFile",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file_id",
"value": "",
"description": "Required. File identifier to get info about",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/getFile",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"getFile"
]
},
"description": "Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again."
}
},
{
"name": "answerInlineQuery",
"request": {
"method": "POST",
"body": {
"mode": "formdata",
"formdata": [
{
"key": "inline_query_id",
"value": "",
"description": "Required. Unique identifier for the answered query",
"type": "text"
},
{
"key": "results",
"value": "",
"description": "Required. A JSON-serialized array of results for the inline query",
"type": "text"
},
{
"key": "cache_time",
"value": "",
"description": "Optional. The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.",
"type": "text"
},
{
"key": "is_personal",
"value": "",
"description": "Optional. Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query",
"type": "text"
},
{
"key": "next_offset",
"value": "",
"description": "Optional. Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.",
"type": "text"
}
]
},
"url": {
"raw": "https://api.telegram.org/bot{{token}}/answerInlineQuery",
"protocol": "https",
"host": [
"api",
"telegram",
"org"
],
"path": [
"bot{{token}}",
"answerInlineQuery"
]
},
"description": "Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed."
}
}
]
}

1296
files/postman/v200.json Normal file
View File

File diff suppressed because it is too large Load Diff

1457
files/postman/v210.json Normal file
View File

File diff suppressed because it is too large Load Diff

1457
files/postman/v211.json Normal file
View File

File diff suppressed because it is too large Load Diff

1664
files/postman/v220.json Normal file
View File

File diff suppressed because it is too large Load Diff

1676
files/postman/v230.json Normal file
View File

File diff suppressed because it is too large Load Diff

1718
files/postman/v231.json Normal file
View File

File diff suppressed because it is too large Load Diff

2059
files/postman/v300.json Normal file
View File

File diff suppressed because it is too large Load Diff

2464
files/postman/v310.json Normal file
View File

File diff suppressed because it is too large Load Diff

2722
files/postman/v320.json Normal file
View File

File diff suppressed because it is too large Load Diff

2722
files/postman/v330.json Normal file
View File

File diff suppressed because it is too large Load Diff

2961
files/postman/v350.json Normal file
View File

File diff suppressed because it is too large Load Diff

3015
files/postman/v360.json Normal file
View File

File diff suppressed because it is too large Load Diff

3234
files/postman/v400.json Normal file
View File

File diff suppressed because it is too large Load Diff

3234
files/postman/v410.json Normal file
View File

File diff suppressed because it is too large Load Diff

3338
files/postman/v420.json Normal file
View File

File diff suppressed because it is too large Load Diff

3338
files/postman/v430.json Normal file
View File

File diff suppressed because it is too large Load Diff

3357
files/postman/v440.json Normal file
View File

File diff suppressed because it is too large Load Diff

3400
files/postman/v450.json Normal file
View File

File diff suppressed because it is too large Load Diff

3430
files/postman/v460.json Normal file
View File

File diff suppressed because it is too large Load Diff

3589
files/postman/v470.json Normal file
View File

File diff suppressed because it is too large Load Diff

3619
files/postman/v480.json Normal file
View File

File diff suppressed because it is too large Load Diff

3619
files/postman/v490.json Normal file
View File

File diff suppressed because it is too large Load Diff

4036
files/postman/v500.json Normal file
View File

File diff suppressed because it is too large Load Diff

4183
files/postman/v510.json Normal file
View File

File diff suppressed because it is too large Load Diff

4195
files/postman/v520.json Normal file
View File

File diff suppressed because it is too large Load Diff

4257
files/postman/v530.json Normal file
View File

File diff suppressed because it is too large Load Diff

846
files/yaml/v100.yaml Normal file
View File

@ -0,0 +1,846 @@
types:
-
name: Update
description: 'This object represents an incoming update.'
fields:
-
name: update_id
types:
- int
optional: false
description: 'The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order.'
-
name: message
types:
- Message
optional: true
description: 'Optional. New incoming message of any kind — text, photo, sticker, etc.'
-
name: User
description: 'This object represents a Telegram user or bot.'
fields:
-
name: id
types:
- int
optional: false
description: 'Unique identifier for this user or bot'
-
name: first_name
types:
- string
optional: false
description: 'User‘s or bot’s first name'
-
name: last_name
types:
- string
optional: true
description: 'Optional. User‘s or bot’s last name'
-
name: username
types:
- string
optional: true
description: 'Optional. User‘s or bot’s username'
-
name: GroupChat
description: 'This object represents a group chat.'
fields:
-
name: id
types:
- int
optional: false
description: 'Unique identifier for this group chat'
-
name: title
types:
- string
optional: false
description: 'Group name'
-
name: Message
description: 'This object represents a message.'
fields:
-
name: message_id
types:
- int
optional: false
description: 'Unique message identifier'
-
name: from
types:
- User
optional: false
description: Sender
-
name: date
types:
- int
optional: false
description: 'Date the message was sent in Unix time'
-
name: chat
types:
- User
- GroupChat
optional: false
description: 'Conversation the message belongs to — user in case of a private message, GroupChat in case of a group'
-
name: forward_from
types:
- User
optional: true
description: 'Optional. For forwarded messages, sender of the original message'
-
name: forward_date
types:
- int
optional: true
description: 'Optional. For forwarded messages, date the original message was sent in Unix time'
-
name: reply_to_message
types:
- Message
optional: true
description: 'Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.'
-
name: text
types:
- string
optional: true
description: 'Optional. For text messages, the actual UTF-8 text of the message'
-
name: audio
types:
- Audio
optional: true
description: 'Optional. Message is an audio file, information about the file'
-
name: document
types:
- Document
optional: true
description: 'Optional. Message is a general file, information about the file'
-
name: photo
types:
- Array<PhotoSize>
optional: true
description: 'Optional. Message is a photo, available sizes of the photo'
-
name: sticker
types:
- Sticker
optional: true
description: 'Optional. Message is a sticker, information about the sticker'
-
name: video
types:
- Video
optional: true
description: 'Optional. Message is a video, information about the video'
-
name: contact
types:
- Contact
optional: true
description: 'Optional. Message is a shared contact, information about the contact'
-
name: location
types:
- Location
optional: true
description: 'Optional. Message is a shared location, information about the location'
-
name: new_chat_participant
types:
- User
optional: true
description: 'Optional. A new member was added to the group, information about them (this member may be bot itself)'
-
name: left_chat_participant
types:
- User
optional: true
description: 'Optional. A member was removed from the group, information about them (this member may be bot itself)'
-
name: new_chat_title
types:
- string
optional: true
description: 'Optional. A group title was changed to this value'
-
name: new_chat_photo
types:
- Array<PhotoSize>
optional: true
description: 'Optional. A group photo was change to this value'
-
name: delete_chat_photo
types:
- bool
optional: true
description: 'Optional. Informs that the group photo was deleted'
-
name: group_chat_created
types:
- bool
optional: true
description: 'Optional. Informs that the group has been created'
-
name: PhotoSize
description: 'This object represents one size of a photo or a file / sticker thumbnail.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: width
types:
- int
optional: false
description: 'Photo width'
-
name: height
types:
- int
optional: false
description: 'Photo height'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Audio
description: 'This object represents an audio file (voice note).'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: duration
types:
- int
optional: false
description: 'Duration of the audio in seconds as defined by sender'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Document
description: 'This object represents a general file (as opposed to photos and audio files).'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique file identifier'
-
name: thumb
types:
- PhotoSize
optional: false
description: 'Document thumbnail as defined by sender'
-
name: file_name
types:
- string
optional: true
description: 'Optional. Original filename as defined by sender'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Sticker
description: 'This object represents a sticker.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: width
types:
- int
optional: false
description: 'Sticker width'
-
name: height
types:
- int
optional: false
description: 'Sticker height'
-
name: thumb
types:
- PhotoSize
optional: false
description: 'Sticker thumbnail in .webp or .jpg format'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Video
description: 'This object represents a video file.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: width
types:
- int
optional: false
description: 'Video width as defined by sender'
-
name: height
types:
- int
optional: false
description: 'Video height as defined by sender'
-
name: duration
types:
- int
optional: false
description: 'Duration of the video in seconds as defined by sender'
-
name: thumb
types:
- PhotoSize
optional: false
description: 'Video thumbnail'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. Mime type of a file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: caption
types:
- string
optional: true
description: 'Optional. Text description of the video (usually empty)'
-
name: Contact
description: 'This object represents a phone contact.'
fields:
-
name: phone_number
types:
- string
optional: false
description: 'Contact''s phone number'
-
name: first_name
types:
- string
optional: false
description: 'Contact''s first name'
-
name: last_name
types:
- string
optional: true
description: 'Optional. Contact''s last name'
-
name: user_id
types:
- string
optional: true
description: 'Optional. Contact''s user identifier in Telegram'
-
name: Location
description: 'This object represents a point on the map.'
fields:
-
name: longitude
types:
- float
optional: false
description: 'Longitude as defined by sender'
-
name: latitude
types:
- float
optional: false
description: 'Latitude as defined by sender'
-
name: UserProfilePhotos
description: 'This object represent a user''s profile pictures.'
fields:
-
name: total_count
types:
- int
optional: false
description: 'Total number of profile pictures the target user has'
-
name: photos
types:
- Array<Array<PhotoSize>>
optional: false
description: 'Requested profile pictures (in up to 4 sizes each)'
-
name: ReplyKeyboardMarkup
description: 'This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).'
fields:
-
name: keyboard
types:
- Array<Array<string>>
optional: false
description: 'Array of button rows, each represented by an Array of Strings'
-
name: resize_keyboard
types:
- bool
optional: true
description: 'Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app''s standard keyboard.'
-
name: one_time_keyboard
types:
- bool
optional: true
description: 'Optional. Requests clients to hide the keyboard as soon as it''s been used. Defaults to false.'
-
name: selective
types:
- bool
optional: true
description: 'Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.'
-
name: ReplyKeyboardHide
description: 'Upon receiving a message with this object, Telegram clients will hide the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).'
fields:
-
name: hide_keyboard
types:
- bool
optional: false
description: 'Requests clients to hide the custom keyboard'
-
name: selective
types:
- bool
optional: true
description: 'Optional. Use this parameter if you want to hide keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven''t voted yet.'
-
name: ForceReply
description: 'Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply''). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.'
fields:
-
name: force_reply
types:
- bool
optional: false
description: 'Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'''
-
name: selective
types:
- bool
optional: true
description: 'Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.'
-
name: InputFile
description: 'This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.'
fields: { }
methods:
-
name: getUpdates
description: 'Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.'
fields:
-
name: offset
types:
- int
required: false
description: '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.'
-
name: limit
types:
- int
required: false
description: 'Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100'
-
name: timeout
types:
- int
required: false
description: 'Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling'
return_types:
- Array<Update>
-
name: 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."
fields:
-
name: url
types:
- string
required: false
description: 'HTTPS url to send updates to. Use an empty string to remove webhook integration'
return_types: { }
-
name: 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.'
fields: { }
return_types:
- User
-
name: sendMessage
description: 'Use this method to send text messages. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: text
types:
- string
required: true
description: 'Text of the message to be sent'
-
name: disable_web_page_preview
types:
- bool
required: false
description: 'Disables link previews for links in this message'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: forwardMessage
description: 'Use this method to forward messages of any kind. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: from_chat_id
types:
- int
required: true
description: 'Unique identifier for the chat where the original message was sent — User or GroupChat id'
-
name: message_id
types:
- int
required: true
description: 'Unique message identifier'
return_types:
- Message
-
name: sendPhoto
description: 'Use this method to send photos. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: photo
types:
- InputFile
- string
required: true
description: '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.'
-
name: caption
types:
- string
required: false
description: 'Photo caption (may also be used when resending photos by file_id).'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: audio
types:
- InputFile
- string
required: true
description: '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.'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: document
types:
- InputFile
- string
required: true
description: '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.'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: sendSticker
description: 'Use this method to send .webp stickers. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: sticker
types:
- InputFile
- string
required: true
description: '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.'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: video
types:
- InputFile
- string
required: true
description: '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.'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: sendLocation
description: 'Use this method to send point on the map. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: latitude
types:
- float
required: true
description: 'Latitude of location'
-
name: longitude
types:
- float
required: true
description: 'Longitude of location'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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."
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: action
types:
- string
required: true
description: '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.'
return_types: { }
-
name: getUserProfilePhotos
description: 'Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.'
fields:
-
name: user_id
types:
- int
required: true
description: 'Unique identifier of the target user'
-
name: offset
types:
- int
required: false
description: 'Sequential number of the first photo to be returned. By default, all photos are returned.'
-
name: limit
types:
- int
required: false
description: 'Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.'
return_types:
- UserProfilePhotos

864
files/yaml/v110.yaml Normal file
View File

@ -0,0 +1,864 @@
types:
-
name: Update
description: 'This object represents an incoming update.'
fields:
-
name: update_id
types:
- int
optional: false
description: 'The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order.'
-
name: message
types:
- Message
optional: true
description: 'Optional. New incoming message of any kind — text, photo, sticker, etc.'
-
name: User
description: 'This object represents a Telegram user or bot.'
fields:
-
name: id
types:
- int
optional: false
description: 'Unique identifier for this user or bot'
-
name: first_name
types:
- string
optional: false
description: 'User‘s or bot’s first name'
-
name: last_name
types:
- string
optional: true
description: 'Optional. User‘s or bot’s last name'
-
name: username
types:
- string
optional: true
description: 'Optional. User‘s or bot’s username'
-
name: GroupChat
description: 'This object represents a group chat.'
fields:
-
name: id
types:
- int
optional: false
description: 'Unique identifier for this group chat'
-
name: title
types:
- string
optional: false
description: 'Group name'
-
name: Message
description: 'This object represents a message.'
fields:
-
name: message_id
types:
- int
optional: false
description: 'Unique message identifier'
-
name: from
types:
- User
optional: false
description: Sender
-
name: date
types:
- int
optional: false
description: 'Date the message was sent in Unix time'
-
name: chat
types:
- User
- GroupChat
optional: false
description: 'Conversation the message belongs to — user in case of a private message, GroupChat in case of a group'
-
name: forward_from
types:
- User
optional: true
description: 'Optional. For forwarded messages, sender of the original message'
-
name: forward_date
types:
- int
optional: true
description: 'Optional. For forwarded messages, date the original message was sent in Unix time'
-
name: reply_to_message
types:
- Message
optional: true
description: 'Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.'
-
name: text
types:
- string
optional: true
description: 'Optional. For text messages, the actual UTF-8 text of the message'
-
name: audio
types:
- Audio
optional: true
description: 'Optional. Message is an audio file, information about the file'
-
name: document
types:
- Document
optional: true
description: 'Optional. Message is a general file, information about the file'
-
name: photo
types:
- Array<PhotoSize>
optional: true
description: 'Optional. Message is a photo, available sizes of the photo'
-
name: sticker
types:
- Sticker
optional: true
description: 'Optional. Message is a sticker, information about the sticker'
-
name: video
types:
- Video
optional: true
description: 'Optional. Message is a video, information about the video'
-
name: caption
types:
- string
optional: true
description: 'Optional. Caption for the photo or video'
-
name: contact
types:
- Contact
optional: true
description: 'Optional. Message is a shared contact, information about the contact'
-
name: location
types:
- Location
optional: true
description: 'Optional. Message is a shared location, information about the location'
-
name: new_chat_participant
types:
- User
optional: true
description: 'Optional. A new member was added to the group, information about them (this member may be bot itself)'
-
name: left_chat_participant
types:
- User
optional: true
description: 'Optional. A member was removed from the group, information about them (this member may be bot itself)'
-
name: new_chat_title
types:
- string
optional: true
description: 'Optional. A group title was changed to this value'
-
name: new_chat_photo
types:
- Array<PhotoSize>
optional: true
description: 'Optional. A group photo was change to this value'
-
name: delete_chat_photo
types:
- bool
optional: true
description: 'Optional. Informs that the group photo was deleted'
-
name: group_chat_created
types:
- bool
optional: true
description: 'Optional. Informs that the group has been created'
-
name: PhotoSize
description: 'This object represents one size of a photo or a file / sticker thumbnail.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: width
types:
- int
optional: false
description: 'Photo width'
-
name: height
types:
- int
optional: false
description: 'Photo height'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Audio
description: 'This object represents an audio file (voice note).'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: duration
types:
- int
optional: false
description: 'Duration of the audio in seconds as defined by sender'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Document
description: 'This object represents a general file (as opposed to photos and audio files).'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique file identifier'
-
name: thumb
types:
- PhotoSize
optional: true
description: 'Optional. Document thumbnail as defined by sender'
-
name: file_name
types:
- string
optional: true
description: 'Optional. Original filename as defined by sender'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Sticker
description: 'This object represents a sticker.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: width
types:
- int
optional: false
description: 'Sticker width'
-
name: height
types:
- int
optional: false
description: 'Sticker height'
-
name: thumb
types:
- PhotoSize
optional: true
description: 'Optional. Sticker thumbnail in .webp or .jpg format'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Video
description: 'This object represents a video file.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: width
types:
- int
optional: false
description: 'Video width as defined by sender'
-
name: height
types:
- int
optional: false
description: 'Video height as defined by sender'
-
name: duration
types:
- int
optional: false
description: 'Duration of the video in seconds as defined by sender'
-
name: thumb
types:
- PhotoSize
optional: true
description: 'Optional. Video thumbnail'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. Mime type of a file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Contact
description: 'This object represents a phone contact.'
fields:
-
name: phone_number
types:
- string
optional: false
description: 'Contact''s phone number'
-
name: first_name
types:
- string
optional: false
description: 'Contact''s first name'
-
name: last_name
types:
- string
optional: true
description: 'Optional. Contact''s last name'
-
name: user_id
types:
- int
optional: true
description: 'Optional. Contact''s user identifier in Telegram'
-
name: Location
description: 'This object represents a point on the map.'
fields:
-
name: longitude
types:
- float
optional: false
description: 'Longitude as defined by sender'
-
name: latitude
types:
- float
optional: false
description: 'Latitude as defined by sender'
-
name: UserProfilePhotos
description: 'This object represent a user''s profile pictures.'
fields:
-
name: total_count
types:
- int
optional: false
description: 'Total number of profile pictures the target user has'
-
name: photos
types:
- Array<Array<PhotoSize>>
optional: false
description: 'Requested profile pictures (in up to 4 sizes each)'
-
name: ReplyKeyboardMarkup
description: 'This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).'
fields:
-
name: keyboard
types:
- Array<Array<string>>
optional: false
description: 'Array of button rows, each represented by an Array of Strings'
-
name: resize_keyboard
types:
- bool
optional: true
description: 'Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app''s standard keyboard.'
-
name: one_time_keyboard
types:
- bool
optional: true
description: 'Optional. Requests clients to hide the keyboard as soon as it''s been used. Defaults to false.'
-
name: selective
types:
- bool
optional: true
description: 'Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.'
-
name: ReplyKeyboardHide
description: 'Upon receiving a message with this object, Telegram clients will hide the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).'
fields:
-
name: hide_keyboard
types:
- bool
optional: false
description: 'Requests clients to hide the custom keyboard'
-
name: selective
types:
- bool
optional: true
description: 'Optional. Use this parameter if you want to hide keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven''t voted yet.'
-
name: ForceReply
description: 'Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply''). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.'
fields:
-
name: force_reply
types:
- bool
optional: false
description: 'Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'''
-
name: selective
types:
- bool
optional: true
description: 'Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.'
-
name: InputFile
description: 'This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.'
fields: { }
methods:
-
name: getUpdates
description: 'Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.'
fields:
-
name: offset
types:
- int
required: false
description: '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.'
-
name: limit
types:
- int
required: false
description: 'Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100'
-
name: timeout
types:
- int
required: false
description: 'Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling'
return_types:
- Array<Update>
-
name: 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."
fields:
-
name: url
types:
- string
required: false
description: 'HTTPS url to send updates to. Use an empty string to remove webhook integration'
return_types: { }
-
name: 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.'
fields: { }
return_types:
- User
-
name: sendMessage
description: 'Use this method to send text messages. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: text
types:
- string
required: true
description: 'Text of the message to be sent'
-
name: disable_web_page_preview
types:
- bool
required: false
description: 'Disables link previews for links in this message'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: forwardMessage
description: 'Use this method to forward messages of any kind. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: from_chat_id
types:
- int
required: true
description: 'Unique identifier for the chat where the original message was sent — User or GroupChat id'
-
name: message_id
types:
- int
required: true
description: 'Unique message identifier'
return_types:
- Message
-
name: sendPhoto
description: 'Use this method to send photos. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: photo
types:
- InputFile
- string
required: true
description: '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.'
-
name: caption
types:
- string
required: false
description: 'Photo caption (may also be used when resending photos by file_id).'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: audio
types:
- InputFile
- string
required: true
description: '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.'
-
name: duration
types:
- int
required: false
description: 'Duration of sent audio in seconds'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: document
types:
- InputFile
- string
required: true
description: '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.'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: sendSticker
description: 'Use this method to send .webp stickers. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: sticker
types:
- InputFile
- string
required: true
description: '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.'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: video
types:
- InputFile
- string
required: true
description: '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.'
-
name: duration
types:
- int
required: false
description: 'Duration of sent video in seconds'
-
name: caption
types:
- string
required: false
description: 'Video caption (may also be used when resending videos by file_id).'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: sendLocation
description: 'Use this method to send point on the map. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: latitude
types:
- float
required: true
description: 'Latitude of location'
-
name: longitude
types:
- float
required: true
description: 'Longitude of location'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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."
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: action
types:
- string
required: true
description: '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.'
return_types: { }
-
name: getUserProfilePhotos
description: 'Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.'
fields:
-
name: user_id
types:
- int
required: true
description: 'Unique identifier of the target user'
-
name: offset
types:
- int
required: false
description: 'Sequential number of the first photo to be returned. By default, all photos are returned.'
-
name: limit
types:
- int
required: false
description: 'Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.'
return_types:
- UserProfilePhotos

973
files/yaml/v140.yaml Normal file
View File

@ -0,0 +1,973 @@
types:
-
name: Update
description: 'This object represents an incoming update.'
fields:
-
name: update_id
types:
- int
optional: false
description: 'The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order.'
-
name: message
types:
- Message
optional: true
description: 'Optional. New incoming message of any kind — text, photo, sticker, etc.'
-
name: User
description: 'This object represents a Telegram user or bot.'
fields:
-
name: id
types:
- int
optional: false
description: 'Unique identifier for this user or bot'
-
name: first_name
types:
- string
optional: false
description: 'User‘s or bot’s first name'
-
name: last_name
types:
- string
optional: true
description: 'Optional. User‘s or bot’s last name'
-
name: username
types:
- string
optional: true
description: 'Optional. User‘s or bot’s username'
-
name: GroupChat
description: 'This object represents a group chat.'
fields:
-
name: id
types:
- int
optional: false
description: 'Unique identifier for this group chat'
-
name: title
types:
- string
optional: false
description: 'Group name'
-
name: Message
description: 'This object represents a message.'
fields:
-
name: message_id
types:
- int
optional: false
description: 'Unique message identifier'
-
name: from
types:
- User
optional: false
description: Sender
-
name: date
types:
- int
optional: false
description: 'Date the message was sent in Unix time'
-
name: chat
types:
- User
- GroupChat
optional: false
description: 'Conversation the message belongs to — user in case of a private message, GroupChat in case of a group'
-
name: forward_from
types:
- User
optional: true
description: 'Optional. For forwarded messages, sender of the original message'
-
name: forward_date
types:
- int
optional: true
description: 'Optional. For forwarded messages, date the original message was sent in Unix time'
-
name: reply_to_message
types:
- Message
optional: true
description: 'Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.'
-
name: text
types:
- string
optional: true
description: 'Optional. For text messages, the actual UTF-8 text of the message'
-
name: audio
types:
- Audio
optional: true
description: 'Optional. Message is an audio file, information about the file'
-
name: document
types:
- Document
optional: true
description: 'Optional. Message is a general file, information about the file'
-
name: photo
types:
- Array<PhotoSize>
optional: true
description: 'Optional. Message is a photo, available sizes of the photo'
-
name: sticker
types:
- Sticker
optional: true
description: 'Optional. Message is a sticker, information about the sticker'
-
name: video
types:
- Video
optional: true
description: 'Optional. Message is a video, information about the video'
-
name: voice
types:
- Voice
optional: true
description: 'Optional. Message is a voice message, information about the file'
-
name: caption
types:
- string
optional: true
description: 'Optional. Caption for the photo or video'
-
name: contact
types:
- Contact
optional: true
description: 'Optional. Message is a shared contact, information about the contact'
-
name: location
types:
- Location
optional: true
description: 'Optional. Message is a shared location, information about the location'
-
name: new_chat_participant
types:
- User
optional: true
description: 'Optional. A new member was added to the group, information about them (this member may be bot itself)'
-
name: left_chat_participant
types:
- User
optional: true
description: 'Optional. A member was removed from the group, information about them (this member may be bot itself)'
-
name: new_chat_title
types:
- string
optional: true
description: 'Optional. A group title was changed to this value'
-
name: new_chat_photo
types:
- Array<PhotoSize>
optional: true
description: 'Optional. A group photo was change to this value'
-
name: delete_chat_photo
types:
- bool
optional: true
description: 'Optional. Informs that the group photo was deleted'
-
name: group_chat_created
types:
- bool
optional: true
description: 'Optional. Informs that the group has been created'
-
name: PhotoSize
description: 'This object represents one size of a photo or a file / sticker thumbnail.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: width
types:
- int
optional: false
description: 'Photo width'
-
name: height
types:
- int
optional: false
description: 'Photo height'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Audio
description: 'This object represents an audio file to be treated as music by the Telegram clients.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: duration
types:
- int
optional: false
description: 'Duration of the audio in seconds as defined by sender'
-
name: performer
types:
- string
optional: true
description: 'Optional. Performer of the audio as defined by sender or by audio tags'
-
name: title
types:
- string
optional: true
description: 'Optional. Title of the audio as defined by sender or by audio tags'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Document
description: 'This object represents a general file (as opposed to photos, voice messages and audio files).'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique file identifier'
-
name: thumb
types:
- PhotoSize
optional: true
description: 'Optional. Document thumbnail as defined by sender'
-
name: file_name
types:
- string
optional: true
description: 'Optional. Original filename as defined by sender'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Sticker
description: 'This object represents a sticker.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: width
types:
- int
optional: false
description: 'Sticker width'
-
name: height
types:
- int
optional: false
description: 'Sticker height'
-
name: thumb
types:
- PhotoSize
optional: true
description: 'Optional. Sticker thumbnail in .webp or .jpg format'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Video
description: 'This object represents a video file.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: width
types:
- int
optional: false
description: 'Video width as defined by sender'
-
name: height
types:
- int
optional: false
description: 'Video height as defined by sender'
-
name: duration
types:
- int
optional: false
description: 'Duration of the video in seconds as defined by sender'
-
name: thumb
types:
- PhotoSize
optional: true
description: 'Optional. Video thumbnail'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. Mime type of a file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Voice
description: 'This object represents a voice note.'
fields:
-
name: file_id
types:
- string
optional: false
description: 'Unique identifier for this file'
-
name: duration
types:
- int
optional: false
description: 'Duration of the audio in seconds as defined by sender'
-
name: mime_type
types:
- string
optional: true
description: 'Optional. MIME type of the file as defined by sender'
-
name: file_size
types:
- int
optional: true
description: 'Optional. File size'
-
name: Contact
description: 'This object represents a phone contact.'
fields:
-
name: phone_number
types:
- string
optional: false
description: 'Contact''s phone number'
-
name: first_name
types:
- string
optional: false
description: 'Contact''s first name'
-
name: last_name
types:
- string
optional: true
description: 'Optional. Contact''s last name'
-
name: user_id
types:
- int
optional: true
description: 'Optional. Contact''s user identifier in Telegram'
-
name: Location
description: 'This object represents a point on the map.'
fields:
-
name: longitude
types:
- float
optional: false
description: 'Longitude as defined by sender'
-
name: latitude
types:
- float
optional: false
description: 'Latitude as defined by sender'
-
name: UserProfilePhotos
description: 'This object represent a user''s profile pictures.'
fields:
-
name: total_count
types:
- int
optional: false
description: 'Total number of profile pictures the target user has'
-
name: photos
types:
- Array<Array<PhotoSize>>
optional: false
description: 'Requested profile pictures (in up to 4 sizes each)'
-
name: ReplyKeyboardMarkup
description: 'This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).'
fields:
-
name: keyboard
types:
- Array<Array<string>>
optional: false
description: 'Array of button rows, each represented by an Array of Strings'
-
name: resize_keyboard
types:
- bool
optional: true
description: 'Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app''s standard keyboard.'
-
name: one_time_keyboard
types:
- bool
optional: true
description: 'Optional. Requests clients to hide the keyboard as soon as it''s been used. Defaults to false.'
-
name: selective
types:
- bool
optional: true
description: 'Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.'
-
name: ReplyKeyboardHide
description: 'Upon receiving a message with this object, Telegram clients will hide the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).'
fields:
-
name: hide_keyboard
types:
- bool
optional: false
description: 'Requests clients to hide the custom keyboard'
-
name: selective
types:
- bool
optional: true
description: 'Optional. Use this parameter if you want to hide keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven''t voted yet.'
-
name: ForceReply
description: 'Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply''). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.'
fields:
-
name: force_reply
types:
- bool
optional: false
description: 'Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'''
-
name: selective
types:
- bool
optional: true
description: 'Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.'
-
name: InputFile
description: 'This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.'
fields: { }
methods:
-
name: getUpdates
description: 'Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.'
fields:
-
name: offset
types:
- int
required: false
description: '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.'
-
name: limit
types:
- int
required: false
description: 'Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100'
-
name: timeout
types:
- int
required: false
description: 'Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling'
return_types:
- Array<Update>
-
name: 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. https://www.example.com/<token>. Since nobody else knows your bot‘s token, you can be pretty sure it’s us."
fields:
-
name: url
types:
- string
required: false
description: 'HTTPS url to send updates to. Use an empty string to remove webhook integration'
-
name: certificate
types:
- InputFile
required: false
description: 'Upload your public key certificate so that the root certificate in use can be checked'
return_types: { }
-
name: 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.'
fields: { }
return_types:
- User
-
name: sendMessage
description: 'Use this method to send text messages. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: text
types:
- string
required: true
description: 'Text of the message to be sent'
-
name: parse_mode
types:
- string
required: false
description: 'Send Markdown, if you want Telegram apps to show bold, italic and inline URLs in your bot''s message. For the moment, only Telegram for Android supports this.'
-
name: disable_web_page_preview
types:
- bool
required: false
description: 'Disables link previews for links in this message'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: forwardMessage
description: 'Use this method to forward messages of any kind. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: from_chat_id
types:
- int
required: true
description: 'Unique identifier for the chat where the original message was sent — User or GroupChat id'
-
name: message_id
types:
- int
required: true
description: 'Unique message identifier'
return_types:
- Message
-
name: sendPhoto
description: 'Use this method to send photos. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: photo
types:
- InputFile
- string
required: true
description: '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.'
-
name: caption
types:
- string
required: false
description: 'Photo caption (may also be used when resending photos by file_id).'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: sendAudio
description: "Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .mp3 format. 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.\nFor backward compatibility, when the fields title and performer are both empty and the mime-type of the file to be sent is not audio/mpeg, the file will be sent as a playable voice message. For this to work, the audio must be in an .ogg file encoded with OPUS. This behavior will be phased out in the future. For sending voice messages, use the sendVoice method instead."
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: audio
types:
- InputFile
- string
required: true
description: '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.'
-
name: duration
types:
- int
required: false
description: 'Duration of the audio in seconds'
-
name: performer
types:
- string
required: false
description: Performer
-
name: title
types:
- string
required: false
description: 'Track name'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: document
types:
- InputFile
- string
required: true
description: '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.'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: sendSticker
description: 'Use this method to send .webp stickers. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: sticker
types:
- InputFile
- string
required: true
description: '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.'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: video
types:
- InputFile
- string
required: true
description: '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.'
-
name: duration
types:
- int
required: false
description: 'Duration of sent video in seconds'
-
name: caption
types:
- string
required: false
description: 'Video caption (may also be used when resending videos by file_id).'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: sendVoice
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 Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: voice
types:
- InputFile
- string
required: true
description: '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.'
-
name: duration
types:
- int
required: false
description: 'Duration of sent audio in seconds'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: sendLocation
description: 'Use this method to send point on the map. On success, the sent Message is returned.'
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: latitude
types:
- float
required: true
description: 'Latitude of location'
-
name: longitude
types:
- float
required: true
description: 'Longitude of location'
-
name: reply_to_message_id
types:
- int
required: false
description: 'If the message is a reply, ID of the original message'
-
name: reply_markup
types:
- ReplyKeyboardMarkup
- ReplyKeyboardHide
- ForceReply
required: false
description: 'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name: 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."
fields:
-
name: chat_id
types:
- int
required: true
description: 'Unique identifier for the message recipient — User or GroupChat id'
-
name: action
types:
- string
required: true
description: '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.'
return_types: { }
-
name: getUserProfilePhotos
description: 'Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.'
fields:
-
name: user_id
types:
- int
required: true
description: 'Unique identifier of the target user'
-
name: offset
types:
- int
required: false
description: 'Sequential number of the first photo to be returned. By default, all photos are returned.'
-
name: limit
types:
- int
required: false
description: 'Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.'
return_types:
- UserProfilePhotos

1007
files/yaml/v150.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

1041
files/yaml/v160.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

1513
files/yaml/v180.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

1541
files/yaml/v182.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

1613
files/yaml/v183.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

2928
files/yaml/v200.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

3048
files/yaml/v210.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

3048
files/yaml/v211.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

3425
files/yaml/v220.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

3453
files/yaml/v230.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

3486
files/yaml/v231.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

4092
files/yaml/v300.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

4453
files/yaml/v310.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

4667
files/yaml/v320.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

4685
files/yaml/v330.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

4938
files/yaml/v350.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

5100
files/yaml/v360.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

5785
files/yaml/v400.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

5881
files/yaml/v410.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

6020
files/yaml/v420.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

6060
files/yaml/v430.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

6131
files/yaml/v440.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

6240
files/yaml/v450.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

6368
files/yaml/v460.yaml Normal file
View File

File diff suppressed because it is too large Load Diff

Some files were not shown because too many files have changed in this diff Show More