telegram-bot-api — quality + safety report

---
name: telegram-bot-api
description: "Telegram Bot API skill. Use when working with Telegram Bot for getUpdates, setWebhook, deleteWebhook. Covers 74 endpoints."
version: 1.0.0
generator: lapsh
---

# Telegram Bot API
API version: 5.0.0

## Auth
No authentication required.

## Base URL
https://api.telegram.org/bot{token}

## Setup
1. No auth setup needed
3. POST /getUpdates -- create first getUpdates

## Endpoints

74 endpoints across 74 groups. See references/api-spec.lap for full details.

### getUpdates
| Method | Path | Description |
|--------|------|-------------|
| POST | /getUpdates | Use this method to receive incoming updates using long polling ([wiki](https://en.wikipedia.org/wiki/Push_technology#Long_polling)). An Array of [Update](https://core.telegram.org/bots/api/#update) objects is returned. |

### setWebhook
| Method | Path | Description |
|--------|------|-------------|
| POST | /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](https://core.telegram.org/bots/api/#update). In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns *True* on success. |

### deleteWebhook
| Method | Path | Description |
|--------|------|-------------|
| POST | /deleteWebhook | Use this method to remove webhook integration if you decide to switch back to [getUpdates](https://core.telegram.org/bots/api/#getupdates). Returns *True* on success. |

### getWebhookInfo
| Method | Path | Description |
|--------|------|-------------|
| POST | /getWebhookInfo | Use this method to get current webhook status. Requires no parameters. On success, returns a [WebhookInfo](https://core.telegram.org/bots/api/#webhookinfo) object. If the bot is using [getUpdates](https://core.telegram.org/bots/api/#getupdates), will return an object with the *url* field empty. |

### getMe
| Method | Path | Description |
|--------|------|-------------|
| POST | /getMe | A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a [User](https://core.telegram.org/bots/api/#user) object. |

### logOut
| Method | Path | Description |
|--------|------|-------------|
| POST | /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. |

### close
| Method | Path | Description |
|--------|------|-------------|
| POST | /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. |

### sendMessage
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendMessage | Use this method to send text messages. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. |

### forwardMessage
| Method | Path | Description |
|--------|------|-------------|
| POST | /forwardMessage | Use this method to forward messages of any kind. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. |

### copyMessage
| Method | Path | Description |
|--------|------|-------------|
| POST | /copyMessage | Use this method to copy messages of any kind. The method is analogous to the method [forwardMessages](https://core.telegram.org/bots/api/#forwardmessages), but the copied message doesn't have a link to the original message. Returns the [MessageId](https://core.telegram.org/bots/api/#messageid) of the sent message on success. |

### sendPhoto
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendPhoto | Use this method to send photos. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. |

### sendAudio
| Method | Path | Description |
|--------|------|-------------|
| POST | /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](https://core.telegram.org/bots/api/#message) is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future. |

### sendDocument
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendDocument | Use this method to send general files. On success, the sent [Message](https://core.telegram.org/bots/api/#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. |

### sendVideo
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendVideo | Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as [Document](https://core.telegram.org/bots/api/#document)). On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. |

### sendAnimation
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendAnimation | Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. |

### sendVoice
| Method | Path | Description |
|--------|------|-------------|
| POST | /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 (other formats may be sent as [Audio](https://core.telegram.org/bots/api/#audio) or [Document](https://core.telegram.org/bots/api/#document)). On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. |

### sendVideoNote
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendVideoNote | As of [v.4.0](https://telegram.org/blog/video-messages-and-telescope), 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](https://core.telegram.org/bots/api/#message) is returned. |

### sendMediaGroup
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendMediaGroup | 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 [Messages](https://core.telegram.org/bots/api/#message) that were sent is returned. |

### sendLocation
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendLocation | Use this method to send point on the map. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. |

### editMessageLiveLocation
| Method | Path | Description |
|--------|------|-------------|
| POST | /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](https://core.telegram.org/bots/api/#stopmessagelivelocation). On success, if the edited message is not an inline message, the edited [Message](https://core.telegram.org/bots/api/#message) is returned, otherwise *True* is returned. |

### stopMessageLiveLocation
| Method | Path | Description |
|--------|------|-------------|
| POST | /stopMessageLiveLocation | 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 [Message](https://core.telegram.org/bots/api/#message) is returned, otherwise *True* is returned. |

### sendVenue
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendVenue | Use this method to send information about a venue. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. |

### sendContact
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendContact | Use this method to send phone contacts. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. |

### sendPoll
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendPoll | Use this method to send a native poll. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. |

### sendDice
| Method | Path | Description |
|--------|------|-------------|
| POST | /sendDice | Use this method to send an animated emoji that will display a random value. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. |

### sendChatAction
| Method | Path | Description |
|--------|------|-------------|
| POST | /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. |

### getUserProfilePhotos
| Method | Path | Description |
|--------|------|-------------|
| POST | /getUserProfilePhotos | Use this method to get a list of profile pictures for a user. Returns a [UserProfilePhotos](https://core.telegram.org/bots/api/#userprofilephotos) object. |

### getFile
| Method | Path | Description |
|--------|------|-------------|
| POST | /getFile | Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a [File](https://core.telegram.org/bots/api/#file) object is returned. The file can then be downloaded via the link `https://api.telegram.org/file/bot<token>/<file_path>`, where `<file_path>` is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling [getFile](https://core.telegram.org/bots/api/#getfile) again. |

### kickChatMember
| Method | Path | Description |
|--------|------|-------------|
| POST | /kickChatMember | 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 [unbanned](https://core.telegram.org/bots/api/#unbanchatmember) 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. |

### unbanChatMember
| Method | Path | Description |
|--------|------|-------------|
| POST | /unbanChatMember | 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*. Retur

… (truncated)