ESC
Example searches: “mask_position”, “string”, “x_shift”, “png_sticker”, “error_code”
Search…
Ctrl+K
⌘K
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram
Toggle dark mode
botapi
Topics
Introduction
Endpoints
Add sticker to set
Use this method to add a new sticker to a set created by the bot
POST
Copy message
Use this method to copy messages of any kind
POST
Edit message caption
Use this method to edit captions of messages
POST
Delete message
Use this method to delete a message
POST
Answer shipping query
If you sent an invoice requesting a shipping address and the parameter *is\_flexible* was specified
POST
Delete sticker from set
Use this method to delete a sticker from a set created by the bot
POST
Forward message
Use this method to forward messages of any kind
POST
Get me
A simple method for testing your bot's auth token
POST
Answer callback query
Use this method to send answers to callback queries sent from [inline keyboards]
POST
Answer inline query
Use this method to send answers to an inline query
POST
Answer pre checkout query
Once the user has confirmed their payment and shipping details
POST
Close
Use this method to close the bot instance before moving it from one local server to another
POST
Create new sticker set
Use this method to create a new sticker set owned by a user
POST
Delete chat photo
Use this method to delete a chat photo
POST
Delete chat sticker set
Use this method to delete a group sticker set from a supergroup
POST
Delete webhook
Use this method to remove webhook integration if you decide to switch back to [getUpdates]
POST
Edit message live location
Use this method to edit live location messages
POST
Edit message media
Use this method to edit animation
POST
Edit message reply markup
Use this method to edit only the reply markup of messages
POST
Edit message text
Use this method to edit text and [game]
POST
Export chat invite link
Use this method to generate a new invite link for a chat; any previously generated link is revoked
POST
Get chat
Use this method to get up to date information about the chat
POST
Get chat administrators
Use this method to get a list of administrators in a chat
POST
Get chat member
Use this method to get information about a member of a chat
POST
Get chat members count
Use this method to get the number of members in a chat
POST
Get file
Use this method to get basic info about a file and prepare it for downloading
POST
Get game high scores
Use this method to get data for high score tables
POST
Get my commands
Use this method to get the current list of the bot's commands
POST
Get sticker set
Use this method to get a sticker set
POST
Get updates
Use this method to receive incoming updates using long polling
POST
Leave chat
Use this method for your bot to leave a group
POST
Get webhook info
Use this method to get current webhook status
POST
Promote chat member
Use this method to promote
POST
Get user profile photos
Use this method to get a list of profile pictures for a user
POST
Kick chat member
Use this method to kick a user from a group
POST
Log out
Use this method to log out from the cloud Bot API server before launching the bot locally
POST
Pin chat message
Use this method to add a message to the list of pinned messages in a chat
POST
Restrict chat member
Use this method to restrict a user in a supergroup
POST
Send animation
Use this method to send animation files
POST
Send audio
Use this method to send audio files
POST
Send chat action
Use this method when you need to tell the user that something is happening on the bot's side
POST
Send contact
Use this method to send phone contacts
POST
Send dice
Use this method to send an animated emoji that will display a random value
POST
Send document
Use this method to send general files
POST
Send game
Use this method to send a game
POST
Send invoice
Use this method to send invoices
POST
Send location
Use this method to send point on the map
POST
Send media group
Use this method to send a group of photos
POST
Send message
Use this method to send text messages
POST
Send photo
Use this method to send photos
POST
Send poll
Use this method to send a native poll
POST
Send sticker
Use this method to send static
POST
Send venue
Use this method to send information about a venue
POST
Set chat title
Use this method to change the title of a chat
POST
Set game score
Use this method to set the score of the specified user in a game
POST
Send video
Use this method to send video files
POST
Set webhook
Use this method to specify a url and receive incoming updates via an outgoing webhook
POST
Unpin chat message
Use this method to remove a message from the list of pinned messages in a chat
POST
Send video note
As of [v
POST
Send voice
Use this method to send audio files
POST
Set chat administrator custom title
Use this method to set a custom title for an administrator in a supergroup promoted by the bot
POST
Set chat description
Use this method to change the description of a group
POST
Set chat permissions
Use this method to set default chat permissions for all members
POST
Set chat photo
Use this method to set a new profile photo for the chat
POST
Set chat sticker set
Use this method to set a new group sticker set for a supergroup
POST
Set my commands
Use this method to change the list of the bot's commands
POST
Set passport data errors
Informs a user that some of the Telegram Passport elements they provided contains errors
POST
Set sticker position in set
Use this method to move a sticker in a set created by the bot to a specific position
POST
Set sticker set thumb
Use this method to set the thumbnail of a sticker set
POST
Stop message live location
Use this method to stop updating a live location message before *live\_period* expires
POST
Upload sticker file
Use this method to upload a
POST
Stop poll
Use this method to stop a poll which was sent by the bot
POST
Unban chat member
Use this method to unban a previously kicked user in a supergroup
POST
Unpin all chat messages
Use this method to clear the list of pinned messages in a chat
POST
Search…
Ctrl+K
⌘K
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram
Toggle dark mode
botapi
Dismiss highlight
Show more
Edit message text