Telegram Bot API

OpenAPI apis-guru messaging

Auto-generated OpenAPI schema

Homepage: https://api.apis.guru/v2/specs/telegram.org/5.0.0.json
Provider: telegram.org
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/telegram.org/5.0.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/telegram.org/5.0.0/openapi.yaml

Tools (76)

Extracted live via the executor SDK.

addStickerToSet.postAddStickerToSet

Use 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 can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
answerCallbackQuery.postAnswerCallbackQuery

Use this method to send answers to callback queries sent from . The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
answerInlineQuery.postAnswerInlineQuery

Use this method to send answers to an inline query. On success, True is returned.
No more than 50 results per query are allowed.
answerPreCheckoutQuery.postAnswerPreCheckoutQuery

Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
answerShippingQuery.postAnswerShippingQuery

If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
close.postClose

Use 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 ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
copyMessage.postCopyMessage

Use this method to copy messages of any kind. The method is analogous to the method , but the copied message doesn't have a link to the original message. Returns the of the sent message on success.
createNewStickerSet.postCreateNewStickerSet

Use 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 png_sticker or tgs_sticker. Returns True on success.
deleteChatPhoto.postDeleteChatPhoto

Use 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 the appropriate admin rights. Returns True on success.
deleteChatStickerSet.postDeleteChatStickerSet

Use 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 admin rights. Use the field can_set_sticker_set optionally returned in requests to check if the bot can use this method. Returns True on success.
deleteMessage.postDeleteMessage

Use 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 hours ago.
- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.
- Bots can delete outgoing messages in private chats, groups, and supergroups.
- Bots can delete incoming messages in private chats.
- Bots granted can_post_messages permissions can delete outgoing messages in channels.
- If the bot is an administrator of a group, it can delete any message there.
- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.
Returns True on success.
deleteStickerFromSet.postDeleteStickerFromSet

Use this method to delete a sticker from a set created by the bot. Returns True on success.
deleteWebhook.postDeleteWebhook

Use this method to remove webhook integration if you decide to switch back to . Returns True on success.
editMessageCaption.postEditMessageCaption

Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited is returned, otherwise True is returned.
editMessageLiveLocation.postEditMessageLiveLocation

Use 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 . On success, if the edited message is not an inline message, the edited is returned, otherwise True is returned.
editMessageMedia.postEditMessageMedia

Use 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 for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded. Use a previously uploaded file via its file_id or specify a URL. On success, if the edited message was sent by the bot, the edited is returned, otherwise True is returned.
editMessageReplyMarkup.postEditMessageReplyMarkup

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited is returned, otherwise True is returned.
editMessageText.postEditMessageText

Use this method to edit text and messages. On success, if the edited message is not an inline message, the edited is returned, otherwise True is returned.
exportChatInviteLink.postExportChatInviteLink

Use 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 work and must have the appropriate admin rights. Returns the new invite link as String on success.
forwardMessage.postForwardMessage

Use this method to forward messages of any kind. On success, the sent is returned.
getChat.postGetChat

Use 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 channel, etc.). Returns a object on success.
getChatAdministrators.postGetChatAdministrators

Use this method to get a list of administrators in a chat. On success, returns an Array of objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
getChatMember.postGetChatMember

Use this method to get information about a member of a chat. Returns a object on success.
getChatMembersCount.postGetChatMembersCount

Use this method to get the number of members in a chat. Returns Int on success.
getFile.postGetFile

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 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 again.
getGameHighScores.postGetGameHighScores

Use 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 an Array of objects.
This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.
getMe.postGetMe

A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a object.
getMyCommands.postGetMyCommands

Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of on success.
getStickerSet.postGetStickerSet

Use this method to get a sticker set. On success, a object is returned.
getUpdates.postGetUpdates

Use this method to receive incoming updates using long polling (). An Array of objects is returned.
getUserProfilePhotos.postGetUserProfilePhotos

Use this method to get a list of profile pictures for a user. Returns a object.
getWebhookInfo.postGetWebhookInfo

Use this method to get current webhook status. Requires no parameters. On success, returns a object. If the bot is using , will return an object with the url field empty.
kickChatMember.postKickChatMember

Use 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 group on their own using invite links, etc., unless first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
leaveChat.postLeaveChat

Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
logOut.postLogOut

Use 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 is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
pinChatMessage.postPinChatMessage

Use 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 this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.
promoteChatMember.postPromoteChatMember

Use 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 appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.
restrictChatMember.postRestrictChatMember

Use 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 rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
sendAnimation.postSendAnimation

Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
sendAudio.postSendAudio

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 or .M4A format. On success, the sent is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
For sending voice messages, use the method instead.
sendChatAction.postSendChatAction

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). Returns True on success.
Example: The needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use with action = upload_photo. The user will see a “sending photo” status for the bot.
We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
sendContact.postSendContact

Use this method to send phone contacts. On success, the sent is returned.
sendDice.postSendDice

Use this method to send an animated emoji that will display a random value. On success, the sent is returned.
sendDocument.postSendDocument

Use this method to send general files. On success, the sent 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.
sendGame.postSendGame

Use this method to send a game. On success, the sent is returned.
sendInvoice.postSendInvoice

Use this method to send invoices. On success, the sent is returned.
sendLocation.postSendLocation

Use this method to send point on the map. On success, the sent is returned.
sendMediaGroup.postSendMediaGroup

Use 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 the same type. On success, an array of that were sent is returned.
sendMessage.postSendMessage

Use this method to send text messages. On success, the sent is returned.
sendPhoto.postSendPhoto

Use this method to send photos. On success, the sent is returned.
sendPoll.postSendPoll

Use this method to send a native poll. On success, the sent is returned.
sendSticker.postSendSticker

Use this method to send static .WEBP or .TGS stickers. On success, the sent is returned.
sendVenue.postSendVenue

Use this method to send information about a venue. On success, the sent is returned.
sendVideo.postSendVideo

Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as ). On success, the sent is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
sendVideoNote.postSendVideoNote

As of , Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent is returned.
sendVoice.postSendVoice

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 or ). On success, the sent is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
setChatAdministratorCustomTitle.postSetChatAdministratorCustomTitle

Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
setChatDescription.postSetChatDescription

Use 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 the appropriate admin rights. Returns True on success.
setChatPermissions.postSetChatPermissions

Use 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 the can_restrict_members admin rights. Returns True on success.
setChatPhoto.postSetChatPhoto

Use 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 work and must have the appropriate admin rights. Returns True on success.
setChatStickerSet.postSetChatStickerSet

Use 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 admin rights. Use the field can_set_sticker_set optionally returned in requests to check if the bot can use this method. Returns True on success.
setChatTitle.postSetChatTitle

Use 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 must have the appropriate admin rights. Returns True on success.
setGameScore.postSetGameScore

Use 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 , otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
setMyCommands.postSetMyCommands

Use this method to change the list of the bot's commands. Returns True on success.
setPassportDataErrors.postSetPassportDataErrors

Informs 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 the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.
setStickerPositionInSet.postSetStickerPositionInSet

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
setStickerSetThumb.postSetStickerSetThumb

Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.
setWebhook.postSetWebhook

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 . In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
If 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.
stopMessageLiveLocation.postStopMessageLiveLocation

Use 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 is returned, otherwise True is returned.
stopPoll.postStopPoll

Use this method to stop a poll which was sent by the bot. On success, the stopped with the final results is returned.
unbanChatMember.postUnbanChatMember

Use 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 to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
unpinAllChatMessages.postUnpinAllChatMessages

Use 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 work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.
unpinChatMessage.postUnpinChatMessage

Use 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 chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns True on success.
uploadStickerFile.postUploadStickerFile

Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded on success.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools