Telegram

Telegram Bot API (all endpoints)

Auto-generated OpenAPI schema

Communication#openapi#messaging

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Auto-generated OpenAPI schema

Endpoints 74

  • POSTPOST /addStickerToSet/addStickerToSetUse this method to add a new sticker to a set created by the bot. You must use exactly one of the fields *png\_sticker* or *tgs\_sticker*. Animated stickers…
  • POSTPOST /answerCallbackQuery/answerCallbackQueryUse this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the…
  • POSTPOST /answerInlineQuery/answerInlineQueryUse this method to send answers to an inline query. On success, *True* is returned. No more than 50 results per query are allowed.
  • POSTPOST /answerPreCheckoutQuery/answerPreCheckoutQueryOnce the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field…
  • POSTPOST /answerShippingQuery/answerShippingQueryIf you sent an invoice requesting a shipping address and the parameter *is\_flexible* was specified, the Bot API will send an Update with a *shipping\_query*…
  • POSTPOST /close/closeUse this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to…
  • POSTPOST /copyMessage/copyMessageUse this method to copy messages of any kind. The method is analogous to the method forwardMessages, but the copied message doesn't have a link to the…
  • POSTPOST /createNewStickerSet/createNewStickerSetUse this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields…
  • POSTPOST /deleteChatPhoto/deleteChatPhotoUse this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have…
  • POSTPOST /deleteChatStickerSet/deleteChatStickerSetUse this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate…
  • POSTPOST /deleteMessage/deleteMessageUse this method to delete a message, including service messages, with the following limitations: \- A message can only be deleted if it was sent less than 48…
  • POSTPOST /deleteStickerFromSet/deleteStickerFromSetUse this method to delete a sticker from a set created by the bot. Returns *True* on success.
  • POSTPOST /deleteWebhook/deleteWebhookUse this method to remove webhook integration if you decide to switch back to getUpdates. Returns *True* on success.
  • POSTPOST /editMessageCaption/editMessageCaptionUse this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise *True* is…
  • POSTPOST /editMessageLiveLocation/editMessageLiveLocationUse this method to edit live location messages. A location can be edited until its *live\_period* expires or editing is explicitly disabled by a call to…
  • POSTPOST /editMessageMedia/editMessageMediaUse this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio…
  • POSTPOST /editMessageReplyMarkup/editMessageReplyMarkupUse this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned,…
  • POSTPOST /editMessageText/editMessageTextUse this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise *True*…
  • POSTPOST /exportChatInviteLink/exportChatInviteLinkUse this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to…
  • POSTPOST /forwardMessage/forwardMessageUse this method to forward messages of any kind. On success, the sent Message is returned.
  • POSTPOST /getChat/getChatUse this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or…
  • POSTPOST /getChatAdministrators/getChatAdministratorsUse this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat…
  • POSTPOST /getChatMember/getChatMemberUse this method to get information about a member of a chat. Returns a ChatMember object on success.
  • POSTPOST /getChatMembersCount/getChatMembersCountUse this method to get the number of members in a chat. Returns *Int* on success.
  • POSTPOST /getFile/getFileUse 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…
  • POSTPOST /getGameHighScores/getGameHighScoresUse this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns…
  • POSTPOST /getMe/getMeA simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.
  • POSTPOST /getMyCommands/getMyCommandsUse this method to get the current list of the bot's commands. Requires no parameters. Returns Array of BotCommand on success.
  • POSTPOST /getStickerSet/getStickerSetUse this method to get a sticker set. On success, a StickerSet object is returned.
  • POSTPOST /getUpdates/getUpdatesUse this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
  • POSTPOST /getUserProfilePhotos/getUserProfilePhotosUse this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
  • POSTPOST /getWebhookInfo/getWebhookInfoUse this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return…
  • POSTPOST /kickChatMember/kickChatMemberUse this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the…
  • POSTPOST /leaveChat/leaveChatUse this method for your bot to leave a group, supergroup or channel. Returns *True* on success.
  • POSTPOST /logOut/logOutUse this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there…
  • POSTPOST /pinChatMessage/pinChatMessageUse this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for…
  • POSTPOST /promoteChatMember/promoteChatMemberUse this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the…
  • POSTPOST /restrictChatMember/restrictChatMemberUse this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin…
  • POSTPOST /sendAnimation/sendAnimationUse this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send…
  • POSTPOST /sendAudio/sendAudioUse 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 or .M4A format. On…
  • POSTPOST /sendChatAction/sendChatActionUse 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…
  • POSTPOST /sendContact/sendContactUse this method to send phone contacts. On success, the sent Message is returned.
  • POSTPOST /sendDice/sendDiceUse this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
  • POSTPOST /sendDocument/sendDocumentUse 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…
  • POSTPOST /sendGame/sendGameUse this method to send a game. On success, the sent Message is returned.
  • POSTPOST /sendInvoice/sendInvoiceUse this method to send invoices. On success, the sent Message is returned.
  • POSTPOST /sendLocation/sendLocationUse this method to send point on the map. On success, the sent Message is returned.
  • POSTPOST /sendMediaGroup/sendMediaGroupUse this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of…
  • POSTPOST /sendMessage/sendMessageUse this method to send text messages. On success, the sent Message is returned.
  • POSTPOST /sendPhoto/sendPhotoUse this method to send photos. On success, the sent Message is returned.
  • POSTPOST /sendPoll/sendPollUse this method to send a native poll. On success, the sent Message is returned.
  • POSTPOST /sendSticker/sendStickerUse this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned.
  • POSTPOST /sendVenue/sendVenueUse this method to send information about a venue. On success, the sent Message is returned.
  • POSTPOST /sendVideo/sendVideoUse 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.…
  • POSTPOST /sendVideoNote/sendVideoNoteAs of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message…
  • POSTPOST /sendVoice/sendVoiceUse 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…
  • POSTPOST /setChatAdministratorCustomTitle/setChatAdministratorCustomTitleUse this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns *True* on success.
  • POSTPOST /setChatDescription/setChatDescriptionUse this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have…
  • POSTPOST /setChatPermissions/setChatPermissionsUse this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have…
  • POSTPOST /setChatPhoto/setChatPhotoUse this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to…
  • POSTPOST /setChatStickerSet/setChatStickerSetUse this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate…
  • POSTPOST /setChatTitle/setChatTitleUse this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and…
  • POSTPOST /setGameScore/setGameScoreUse this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise…
  • POSTPOST /setMyCommands/setMyCommandsUse this method to change the list of the bot's commands. Returns *True* on success.
  • POSTPOST /setPassportDataErrors/setPassportDataErrorsInforms a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until…
  • POSTPOST /setStickerPositionInSet/setStickerPositionInSetUse this method to move a sticker in a set created by the bot to a specific position. Returns *True* on success.
  • POSTPOST /setStickerSetThumb/setStickerSetThumbUse this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns *True* on success.
  • POSTPOST /setWebhook/setWebhookUse 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…
  • POSTPOST /stopMessageLiveLocation/stopMessageLiveLocationUse this method to stop updating a live location message before *live\_period* expires. On success, if the message was sent by the bot, the sent Message is…
  • POSTPOST /stopPoll/stopPollUse this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned.
  • POSTPOST /unbanChatMember/unbanChatMemberUse this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able…
  • POSTPOST /unpinAllChatMessages/unpinAllChatMessagesUse this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to…
  • POSTPOST /unpinChatMessage/unpinChatMessageUse this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the…
  • POSTPOST /uploadStickerFile/uploadStickerFileUse this method to upload a .PNG file with a sticker for later use in *createNewStickerSet* and *addStickerToSet* methods (can be used multiple times).…

API details

Base URL
https://api.telegram.org/bot{token}
Authentication
None declared in the description
Operations
74 operations on 74 pathsPOST 74
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 5.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Telegram Bot API (all endpoints) in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Telegram Bot API (all endpoints) collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “POST /addStickerToSet” (POST /addStickerToSet), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Telegram Bot API (all endpoints)?

Auto-generated OpenAPI schema It is listed under Communication and has 74 endpoints.

Who publishes the Telegram Bot API (all endpoints)?

It is listed from Telegram's public API description (an OpenAPI document), not published by Telegram on Swastik Codes. Anyone who controls telegram.org can claim the profile by adding a DNS TXT record.

What is the base URL of the Telegram Bot API (all endpoints)?

Requests go to https://api.telegram.org/bot{token}. Endpoint paths are added to this base URL.

How do I authenticate with the Telegram Bot API (all endpoints)?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Telegram Bot API (all endpoints) have?

74 operations on 74 paths (74 POST).

Is forking the Telegram Bot API (all endpoints) free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.