Skip to content
Changelog

Report a bug

Telegram integration: operations for AI agents

Telegram connects to Type.com as an integration. This page lists the 183 operations documented for Claude and Codex in Type.com: 31 read, 131 write, 21 destructive.

About Telegram

Telegram is a cloud-based messaging app with a focus on security and speed. Build bots to send messages, manage chats, and interact with users.

Categories: Communication & Meetings

How to connect Telegram to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

183 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

183 operations listed.

Methods

  • Read

    getWebhookInfo

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

    GET /bot{token}/getWebhookInfo

  • Read

    getMe

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

    GET /bot{token}/getMe

  • Read

    getUserProfilePhotos

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

    GET /bot{token}/getUserProfilePhotos

  • Read

    getUserProfileAudios

    Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.

    GET /bot{token}/getUserProfileAudios

  • Read

    getFile

    Use this method to get basic information 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/`, where `` 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.

    GET /bot{token}/getFile

  • Read

    getChat

    Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.

    GET /bot{token}/getChat

  • Read

    getChatAdministrators

    Use this method to get a list of administrators in a chat. Returns an Array of ChatMember objects.

    GET /bot{token}/getChatAdministrators

  • Read

    getChatMemberCount

    Use this method to get the number of members in a chat. Returns *Integer* on success.

    GET /bot{token}/getChatMemberCount

  • Read

    getChatMember

    Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.

    GET /bot{token}/getChatMember

  • Read

    getUserPersonalChatMessages

    Use this method to get the last messages from the personal chat (i.e., the chat currently added to their profile) of a given user. On success, an Array of Message objects is returned.

    GET /bot{token}/getUserPersonalChatMessages

  • Read

    getForumTopicIconStickers

    Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

    GET /bot{token}/getForumTopicIconStickers

  • Read

    getUserChatBoosts

    Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.

    GET /bot{token}/getUserChatBoosts

  • Read

    getBusinessConnection

    Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.

    GET /bot{token}/getBusinessConnection

  • Read

    getManagedBotToken

    Use this method to get the token of a managed bot. Returns the token as *String* on success.

    GET /bot{token}/getManagedBotToken

  • Read

    getManagedBotAccessSettings

    Use this method to get the access settings of a managed bot. Returns a BotAccessSettings object on success.

    GET /bot{token}/getManagedBotAccessSettings

  • Read

    getMyCommands

    Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.

    GET /bot{token}/getMyCommands

  • Read

    getMyName

    Use this method to get the current bot name for the given user language. Returns BotName on success.

    GET /bot{token}/getMyName

  • Read

    getMyDescription

    Use this method to get the current bot description for the given user language. Returns BotDescription on success.

    GET /bot{token}/getMyDescription

  • Read

    getMyShortDescription

    Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.

    GET /bot{token}/getMyShortDescription

  • Read

    getChatMenuButton

    Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.

    GET /bot{token}/getChatMenuButton

  • Read

    getMyDefaultAdministratorRights

    Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.

    GET /bot{token}/getMyDefaultAdministratorRights

  • Read

    getAvailableGifts

    Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.

    GET /bot{token}/getAvailableGifts

  • Read

    getBusinessAccountStarBalance

    Returns the amount of Telegram Stars owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns StarAmount on success.

    GET /bot{token}/getBusinessAccountStarBalance

  • Read

    getBusinessAccountGifts

    Returns the gifts received and owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns OwnedGifts on success.

    GET /bot{token}/getBusinessAccountGifts

  • Read

    getUserGifts

    Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.

    GET /bot{token}/getUserGifts

  • Read

    getChatGifts

    Returns the gifts owned by a chat. Returns OwnedGifts on success.

    GET /bot{token}/getChatGifts

  • Read

    getStickerSet

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

    GET /bot{token}/getStickerSet

  • Read

    getCustomEmojiStickers

    Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

    GET /bot{token}/getCustomEmojiStickers

  • Read

    getMyStarBalance

    A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.

    GET /bot{token}/getMyStarBalance

  • Read

    getStarTransactions

    Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.

    GET /bot{token}/getStarTransactions

  • Read

    getGameHighScores

    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. Returns an Array of GameHighScore objects.

    GET /bot{token}/getGameHighScores

  • Write

    getUpdates

    Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.

    POST /bot{token}/getUpdates

  • Write

    setWebhook

    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 (a request with response HTTP status code different from `2XY`), we will repeat the request and give up after a reasonable amount of attempts. Returns *True* on success.

    POST /bot{token}/setWebhook

  • Write

    logOut

    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.

    POST /bot{token}/logOut

  • Write

    close

    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.

    POST /bot{token}/close

  • Write

    sendMessage

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

    POST /bot{token}/sendMessage

  • Write

    forwardMessage

    Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.

    POST /bot{token}/forwardMessage

  • Write

    forwardMessages

    Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an Array of MessageId of the sent messages is returned.

    POST /bot{token}/forwardMessages

  • Write

    copyMessage

    Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field *correct_option_ids* is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.

    POST /bot{token}/copyMessage

  • Write

    copyMessages

    Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field *correct_option_ids* is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an Array of MessageId of the sent messages is returned.

    POST /bot{token}/copyMessages

  • Write

    sendPhoto

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

    POST /bot{token}/sendPhoto

  • Write

    sendLivePhoto

    Use this method to send live photos. On success, the sent Message is returned.

    POST /bot{token}/sendLivePhoto

  • Write

    sendAudio

    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 Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.

    POST /bot{token}/sendAudio

  • Write

    sendDocument

    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.

    POST /bot{token}/sendDocument

  • Write

    sendVideo

    Use this method to send video files, Telegram clients support MPEG4 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.

    POST /bot{token}/sendVideo

  • Write

    sendAnimation

    Use 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 animation files of up to 50 MB in size, this limit may be changed in the future.

    POST /bot{token}/sendAnimation

  • Write

    sendVoice

    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, or in .MP3 format, or in .M4A format (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.

    POST /bot{token}/sendVoice

  • Write

    sendVideoNote

    Use this method to send a rounded square MPEG4 video of up to 1 minute long. On success, the sent Message is returned.

    POST /bot{token}/sendVideoNote

  • Write

    sendPaidMedia

    Use this method to send paid media. On success, the sent Message is returned.

    POST /bot{token}/sendPaidMedia

  • Write

    sendMediaGroup

    Use this method to send a group of photos, live 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 Message objects that were sent is returned.

    POST /bot{token}/sendMediaGroup

  • Write

    sendLocation

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

    POST /bot{token}/sendLocation

  • Write

    sendVenue

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

    POST /bot{token}/sendVenue

  • Write

    sendContact

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

    POST /bot{token}/sendContact

  • Write

    sendPoll

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

    POST /bot{token}/sendPoll

  • Write

    sendChecklist

    Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.

    POST /bot{token}/sendChecklist

  • Write

    sendDice

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

    POST /bot{token}/sendDice

  • Write

    sendMessageDraft

    Use this method to stream a partial message to a user while the message is being generated. Note that the streamed draft is ephemeral and acts as a temporary 30-second preview - once the output is finalized, you **must** call sendMessage with the complete message to persist it in the user's chat. Returns *True* on success.

    POST /bot{token}/sendMessageDraft

  • Write

    sendChatAction

    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.

    POST /bot{token}/sendChatAction

  • Write

    setMessageReaction

    Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns *True* on success.

    POST /bot{token}/setMessageReaction

  • Write

    setUserEmojiStatus

    Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns *True* on success.

    POST /bot{token}/setUserEmojiStatus

  • Write

    banChatMember

    Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success.

    POST /bot{token}/banChatMember

  • Write

    unbanChatMember

    Use this method to unban a previously banned 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.

    POST /bot{token}/unbanChatMember

  • Write

    restrictChatMember

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

    POST /bot{token}/restrictChatMember

  • Write

    promoteChatMember

    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 administrator rights. Pass *False* for all boolean parameters to demote a user. Returns *True* on success.

    POST /bot{token}/promoteChatMember

  • Write

    setChatAdministratorCustomTitle

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

    POST /bot{token}/setChatAdministratorCustomTitle

  • Write

    setChatMemberTag

    Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the *can_manage_tags* administrator right. Returns *True* on success.

    POST /bot{token}/setChatMemberTag

  • Write

    banChatSenderChat

    Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of **any of their channels**. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns *True* on success.

    POST /bot{token}/banChatSenderChat

  • Write

    unbanChatSenderChat

    Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns *True* on success.

    POST /bot{token}/unbanChatSenderChat

  • Write

    setChatPermissions

    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* administrator rights. Returns *True* on success.

    POST /bot{token}/setChatPermissions

  • Write

    approveChatJoinRequest

    Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the *can_invite_users* administrator right. Returns *True* on success.

    POST /bot{token}/approveChatJoinRequest

  • Write

    declineChatJoinRequest

    Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the *can_invite_users* administrator right. Returns *True* on success.

    POST /bot{token}/declineChatJoinRequest

  • Write

    answerChatJoinRequestQuery

    Use this method to process a received chat join request query. Returns *True* on success.

    POST /bot{token}/answerChatJoinRequestQuery

  • Write

    sendChatJoinRequestWebApp

    Use this method to process a received chat join request query by showing a Mini App to the user before deciding the outcome. Call answerChatJoinRequestQuery to resolve the join request query based on the user interaction with the Mini App. Returns *True* on success.

    POST /bot{token}/sendChatJoinRequestWebApp

  • Write

    setChatPhoto

    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 administrator rights. Returns *True* on success.

    POST /bot{token}/setChatPhoto

  • Write

    setChatTitle

    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 administrator rights. Returns *True* on success.

    POST /bot{token}/setChatTitle

  • Write

    setChatDescription

    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 administrator rights. Returns *True* on success.

    POST /bot{token}/setChatDescription

  • Write

    pinChatMessage

    Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns *True* on success.

    POST /bot{token}/pinChatMessage

  • Write

    unpinChatMessage

    Use this method to remove a message from the list of pinned messages in a chat. In private chats and channel direct messages chats, all messages can be unpinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin messages in groups and channels respectively. Returns *True* on success.

    POST /bot{token}/unpinChatMessage

  • Write

    unpinAllChatMessages

    Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns *True* on success.

    POST /bot{token}/unpinAllChatMessages

  • Write

    leaveChat

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

    POST /bot{token}/leaveChat

  • Write

    setChatStickerSet

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

    POST /bot{token}/setChatStickerSet

  • Write

    createForumTopic

    Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator right. Returns information about the created topic as a ForumTopic object.

    POST /bot{token}/createForumTopic

  • Write

    editForumTopic

    Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success.

    POST /bot{token}/editForumTopic

  • Write

    closeForumTopic

    Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success.

    POST /bot{token}/closeForumTopic

  • Write

    reopenForumTopic

    Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success.

    POST /bot{token}/reopenForumTopic

  • Write

    unpinAllForumTopicMessages

    Use this method to clear the list of pinned messages in a forum topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns *True* on success.

    POST /bot{token}/unpinAllForumTopicMessages

  • Write

    editGeneralForumTopic

    Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns *True* on success.

    POST /bot{token}/editGeneralForumTopic

  • Write

    closeGeneralForumTopic

    Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns *True* on success.

    POST /bot{token}/closeGeneralForumTopic

  • Write

    reopenGeneralForumTopic

    Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically unhidden if it was hidden. Returns *True* on success.

    POST /bot{token}/reopenGeneralForumTopic

  • Write

    hideGeneralForumTopic

    Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. The topic will be automatically closed if it was open. Returns *True* on success.

    POST /bot{token}/hideGeneralForumTopic

  • Write

    unhideGeneralForumTopic

    Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator rights. Returns *True* on success.

    POST /bot{token}/unhideGeneralForumTopic

  • Write

    unpinAllGeneralForumTopicMessages

    Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the *can_pin_messages* administrator right in the supergroup. Returns *True* on success.

    POST /bot{token}/unpinAllGeneralForumTopicMessages

  • Write

    answerCallbackQuery

    Use 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 chat screen or as an alert. On success, *True* is returned.

    POST /bot{token}/answerCallbackQuery

  • Write

    answerGuestQuery

    Use this method to reply to a received guest message. On success, a SentGuestMessage object is returned.

    POST /bot{token}/answerGuestQuery

  • Write

    setManagedBotAccessSettings

    Use this method to change the access settings of a managed bot. Returns *True* on success.

    POST /bot{token}/setManagedBotAccessSettings

  • Write

    setMyCommands

    Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns *True* on success.

    POST /bot{token}/setMyCommands

  • Write

    setMyName

    Use this method to change the bot's name. Returns *True* on success.

    POST /bot{token}/setMyName

  • Write

    setMyDescription

    Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns *True* on success.

    POST /bot{token}/setMyDescription

  • Write

    setMyShortDescription

    Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns *True* on success.

    POST /bot{token}/setMyShortDescription

  • Write

    setMyProfilePhoto

    Changes the profile photo of the bot. Returns *True* on success.

    POST /bot{token}/setMyProfilePhoto

  • Write

    setChatMenuButton

    Use this method to change the bot's menu button in a private chat, or the default menu button. Returns *True* on success.

    POST /bot{token}/setChatMenuButton

  • Write

    setMyDefaultAdministratorRights

    Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns *True* on success.

    POST /bot{token}/setMyDefaultAdministratorRights

  • Write

    sendGift

    Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns *True* on success.

    POST /bot{token}/sendGift

  • Write

    giftPremiumSubscription

    Gifts a Telegram Premium subscription to the given user. Returns *True* on success.

    POST /bot{token}/giftPremiumSubscription

  • Write

    verifyUser

    Verifies a user on behalf of the organization which is represented by the bot. Returns *True* on success.

    POST /bot{token}/verifyUser

  • Write

    verifyChat

    Verifies a chat on behalf of the organization which is represented by the bot. Returns *True* on success.

    POST /bot{token}/verifyChat

  • Write

    readBusinessMessage

    Marks incoming message as read on behalf of a business account. Requires the *can_read_messages* business bot right. Returns *True* on success.

    POST /bot{token}/readBusinessMessage

  • Write

    setBusinessAccountName

    Changes the first and last name of a managed business account. Requires the *can_change_name* business bot right. Returns *True* on success.

    POST /bot{token}/setBusinessAccountName

  • Write

    setBusinessAccountUsername

    Changes the username of a managed business account. Requires the *can_change_username* business bot right. Returns *True* on success.

    POST /bot{token}/setBusinessAccountUsername

  • Write

    setBusinessAccountBio

    Changes the bio of a managed business account. Requires the *can_change_bio* business bot right. Returns *True* on success.

    POST /bot{token}/setBusinessAccountBio

  • Write

    setBusinessAccountProfilePhoto

    Changes the profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns *True* on success.

    POST /bot{token}/setBusinessAccountProfilePhoto

  • Write

    setBusinessAccountGiftSettings

    Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the *can_change_gift_settings* business bot right. Returns *True* on success.

    POST /bot{token}/setBusinessAccountGiftSettings

  • Write

    transferBusinessAccountStars

    Transfers Telegram Stars from the business account balance to the bot's balance. Requires the *can_transfer_stars* business bot right. Returns *True* on success.

    POST /bot{token}/transferBusinessAccountStars

  • Write

    upgradeGift

    Upgrades a given regular gift to a unique gift. Requires the *can_transfer_and_upgrade_gifts* business bot right. Additionally requires the *can_transfer_stars* business bot right if the upgrade is paid. Returns *True* on success.

    POST /bot{token}/upgradeGift

  • Write

    transferGift

    Transfers an owned unique gift to another user. Requires the *can_transfer_and_upgrade_gifts* business bot right. Requires *can_transfer_stars* business bot right if the transfer is paid. Returns *True* on success.

    POST /bot{token}/transferGift

  • Write

    postStory

    Posts a story on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns Story on success.

    POST /bot{token}/postStory

  • Write

    repostStory

    Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the *can_manage_stories* business bot right for both business accounts. Returns Story on success.

    POST /bot{token}/repostStory

  • Write

    editStory

    Edits a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns Story on success.

    POST /bot{token}/editStory

  • Write

    answerWebAppQuery

    Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.

    POST /bot{token}/answerWebAppQuery

  • Write

    savePreparedInlineMessage

    Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.

    POST /bot{token}/savePreparedInlineMessage

  • Write

    savePreparedKeyboardButton

    Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.

    POST /bot{token}/savePreparedKeyboardButton

  • Write

    editMessageText

    Use this method to edit text, rich and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.

    POST /bot{token}/editMessageText

  • Write

    editMessageCaption

    Use 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 returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.

    POST /bot{token}/editMessageCaption

  • Write

    editMessageMedia

    Use this method to edit animation, audio, document, live photo, photo, or video messages, or to replace a text or a rich message with a media. 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, a live 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 is not an inline message, the edited Message is returned, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.

    POST /bot{token}/editMessageMedia

  • Write

    editMessageLiveLocation

    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 stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise *True* is returned.

    POST /bot{token}/editMessageLiveLocation

  • Write

    stopMessageLiveLocation

    Use this method to stop updating a live location message before *live_period* expires. On success, if the message is not an inline message, the edited Message is returned, otherwise *True* is returned.

    POST /bot{token}/stopMessageLiveLocation

  • Write

    editMessageChecklist

    Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.

    POST /bot{token}/editMessageChecklist

  • Write

    editMessageReplyMarkup

    Use 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, otherwise *True* is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.

    POST /bot{token}/editMessageReplyMarkup

  • Write

    stopPoll

    Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.

    POST /bot{token}/stopPoll

  • Write

    editEphemeralMessageText

    Use this method to edit an ephemeral text or rich message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, *True* is returned.

    POST /bot{token}/editEphemeralMessageText

  • Write

    editEphemeralMessageMedia

    Use this method to edit the media of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, *True* is returned.

    POST /bot{token}/editEphemeralMessageMedia

  • Write

    editEphemeralMessageCaption

    Use this method to edit the caption of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, *True* is returned.

    POST /bot{token}/editEphemeralMessageCaption

  • Write

    editEphemeralMessageReplyMarkup

    Use this method to edit only the reply markup of an ephemeral message. Note that it is not guaranteed that the user will receive the message edit event, especially if they are offline. On success, *True* is returned.

    POST /bot{token}/editEphemeralMessageReplyMarkup

  • Write

    approveSuggestedPost

    Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns *True* on success.

    POST /bot{token}/approveSuggestedPost

  • Write

    declineSuggestedPost

    Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns *True* on success.

    POST /bot{token}/declineSuggestedPost

  • Write

    sendSticker

    Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.

    POST /bot{token}/sendSticker

  • Write

    uploadStickerFile

    Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.

    POST /bot{token}/uploadStickerFile

  • Write

    createNewStickerSet

    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. Returns *True* on success.

    POST /bot{token}/createNewStickerSet

  • Write

    addStickerToSet

    Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns *True* on success.

    POST /bot{token}/addStickerToSet

  • Write

    setStickerPositionInSet

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

    POST /bot{token}/setStickerPositionInSet

  • Write

    replaceStickerInSet

    Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns *True* on success.

    POST /bot{token}/replaceStickerInSet

  • Write

    setStickerEmojiList

    Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns *True* on success.

    POST /bot{token}/setStickerEmojiList

  • Write

    setStickerKeywords

    Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns *True* on success.

    POST /bot{token}/setStickerKeywords

  • Write

    setStickerMaskPosition

    Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns *True* on success.

    POST /bot{token}/setStickerMaskPosition

  • Write

    setStickerSetTitle

    Use this method to set the title of a created sticker set. Returns *True* on success.

    POST /bot{token}/setStickerSetTitle

  • Write

    setStickerSetThumbnail

    Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns *True* on success.

    POST /bot{token}/setStickerSetThumbnail

  • Write

    setCustomEmojiStickerSetThumbnail

    Use this method to set the thumbnail of a custom emoji sticker set. Returns *True* on success.

    POST /bot{token}/setCustomEmojiStickerSetThumbnail

  • Write

    answerInlineQuery

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

    POST /bot{token}/answerInlineQuery

  • Write

    sendInvoice

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

    POST /bot{token}/sendInvoice

  • Write

    answerShippingQuery

    If 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* field to the bot. Use this method to reply to shipping queries. On success, *True* is returned.

    POST /bot{token}/answerShippingQuery

  • Write

    answerPreCheckoutQuery

    Once 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 *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.

    POST /bot{token}/answerPreCheckoutQuery

  • Write

    refundStarPayment

    Refunds a successful payment in Telegram Stars. Returns *True* on success.

    POST /bot{token}/refundStarPayment

  • Write

    editUserStarSubscription

    Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns *True* on success.

    POST /bot{token}/editUserStarSubscription

  • Write

    setPassportDataErrors

    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.

    POST /bot{token}/setPassportDataErrors

  • Write

    sendGame

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

    POST /bot{token}/sendGame

  • Write

    setGameScore

    Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise *True* is returned. Returns an error, if the new score is not greater than the user's current score in the chat and *force* is *False*.

    POST /bot{token}/setGameScore

  • Destructive

    deleteWebhook

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

    POST /bot{token}/deleteWebhook

  • Destructive

    deleteChatPhoto

    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 administrator rights. Returns *True* on success.

    POST /bot{token}/deleteChatPhoto

  • Destructive

    deleteChatStickerSet

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

    POST /bot{token}/deleteChatStickerSet

  • Destructive

    deleteForumTopic

    Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_delete_messages* administrator rights. Returns *True* on success.

    POST /bot{token}/deleteForumTopic

  • Destructive

    replaceManagedBotToken

    Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as *String* on success.

    POST /bot{token}/replaceManagedBotToken

  • Destructive

    deleteMyCommands

    Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns *True* on success.

    POST /bot{token}/deleteMyCommands

  • Destructive

    removeMyProfilePhoto

    Removes the profile photo of the bot. Requires no parameters. Returns *True* on success.

    POST /bot{token}/removeMyProfilePhoto

  • Destructive

    removeUserVerification

    Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns *True* on success.

    POST /bot{token}/removeUserVerification

  • Destructive

    removeChatVerification

    Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns *True* on success.

    POST /bot{token}/removeChatVerification

  • Destructive

    deleteBusinessMessages

    Delete messages on behalf of a business account. Requires the *can_delete_sent_messages* business bot right to delete messages sent by the bot itself, or the *can_delete_all_messages* business bot right to delete any message. Returns *True* on success.

    POST /bot{token}/deleteBusinessMessages

  • Destructive

    removeBusinessAccountProfilePhoto

    Removes the current profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns *True* on success.

    POST /bot{token}/removeBusinessAccountProfilePhoto

  • Destructive

    convertGiftToStars

    Converts a given regular gift to Telegram Stars. Requires the *can_convert_gifts_to_stars* business bot right. Returns *True* on success.

    POST /bot{token}/convertGiftToStars

  • Destructive

    deleteStory

    Deletes a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns *True* on success.

    POST /bot{token}/deleteStory

  • Destructive

    deleteMessage

    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. - Service messages about a supergroup, channel, or forum topic creation can't be deleted. - 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* administrator right in a supergroup or a channel, it can delete any message there. - If the bot has *can_manage_direct_messages* administrator right in a channel, it can delete any message in the corresponding direct messages chat. Returns *True* on success.

    POST /bot{token}/deleteMessage

  • Destructive

    deleteMessages

    Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns *True* on success.

    POST /bot{token}/deleteMessages

  • Destructive

    deleteEphemeralMessage

    Use this method to delete an ephemeral message. Note that it is not guaranteed that the user will receive the message deletion event, especially if they are offline. Returns *True* on success.

    POST /bot{token}/deleteEphemeralMessage

  • Destructive

    deleteMessageReaction

    Use this method to remove a reaction from a message in a group or a supergroup chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns *True* on success.

    POST /bot{token}/deleteMessageReaction

  • Destructive

    deleteAllMessageReactions

    Use this method to remove up to 10000 recent reactions in a group or a supergroup chat added by a given user or chat. The bot must have the 'can_delete_messages' administrator right in the chat. Returns *True* on success.

    POST /bot{token}/deleteAllMessageReactions

  • Destructive

    deleteStickerFromSet

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

    POST /bot{token}/deleteStickerFromSet

  • Destructive

    deleteStickerSet

    Use this method to delete a sticker set that was created by the bot. Returns *True* on success.

    POST /bot{token}/deleteStickerSet

See How connections work for access and permissions, or browse all integrations.

Reference date: October 28, 2026. Telegram API docs.