The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram.
To learn how to create and set up a bot, please consult our Introduction to Bots and Bot FAQ.
January 20, 2016
January 14, 2016
/setinlinefeedback command for @Botfather, new type ChosenInlineResult, new field chosen_inline_result to the Update object.January 4, 2016
/setinline to @BotFather.Each bot is given a unique authentication token when it is created. The token looks something like 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11, but we'll use simply <token> in this document instead. You can learn about obtaining tokens and generating new ones in this document.
All queries to the Telegram Bot API must be served over HTTPS and need to be presented in this form: https://api.telegram.org/bot<token>/METHOD_NAME. Like this for example:
https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/getMeWe support GET and POST HTTP methods. We support four ways of passing parameters in Bot API requests:
The response contains a JSON object, which always has a Boolean field ‘ok’ and may have an optional String field ‘description’ with a human-readable description of the result. If ‘ok’ equals true, the request was successful and the result of the query can be found in the ‘result’ field. In case of an unsuccessful request, ‘ok’ equals false and the error is explained in the ‘description’. An Integer ‘error_code’ field is also returned, but its contents are subject to change in the future.
If you're using webhooks, you can perform a request to the Bot API while sending an answer to the webhook. Use either application/json or application/x-www-form-urlencoded or multipart/form-data response content type for passing parameters. Specify the method to be invoked in the method parameter of the request. It's not possible to know that such a request was successful or get its result.
Please see our FAQ for examples.
There are two mutually exclusive ways of receiving updates for your bot — the getUpdates method on one hand and Webhooks on the other. Incoming updates are stored on the server until the bot receives them either way, but they will not be kept longer than 24 hours.
Regardless of which option you choose, you will receive JSON-serialized Update objects as a result.
This object represents an incoming update.
Only one of the optional parameters can be present in any given update.
| Field | Type | Description |
| update_id | Integer | The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. |
| message | Message | Optional. New incoming message of any kind — text, photo, sticker, etc. |
| inline_query | InlineQuery | Optional. New incoming inline query |
| chosen_inline_result | ChosenInlineResult | Optional. The result of an inline query that was chosen by a user and sent to their chat partner. |
Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
| Parameters | Type | Required | Description |
| offset | Integer | Optional | Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten. |
| limit | Integer | Optional | Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100. |
| timeout | Integer | Optional | Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling |
Notes
1. This method will not work if an outgoing webhook is set up.
2. In order to avoid getting duplicate updates, recalculate offset after each server response.
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, we will give up after a reasonable amount of attempts.
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.
| Parameters | Type | Required | Description |
| url | String | Optional | HTTPS url to send updates to. Use an empty string to remove webhook integration |
| certificate | InputFile | Optional | Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. |
Notes
1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.
3. Ports currently supported for Webhooks: 443, 80, 88, 8443.
All types used in the Bot API responses are represented as JSON-objects.
Inline bots
It is safe to use 32-bit signed integers for storing all Integer fields unless otherwise noted.
Optional fields may be not returned when irrelevant.
This object represents a Telegram user or bot.
| Field | Type | Description |
| id | Integer | Unique identifier for this user or bot |
| first_name | String | User‘s or bot’s first name |
| last_name | String | Optional. User‘s or bot’s last name |
| username | String | Optional. User‘s or bot’s username |
This object represents a chat.
| Field | Type | Description |
| id | Integer | Unique identifier for this chat, not exceeding 1e13 by absolute value |
| type | String | Type of chat, can be either “private”, “group”, “supergroup” or “channel” |
| title | String | Optional. Title, for channels and group chats |
| username | String | Optional. Username, for private chats and channels if available |
| first_name | String | Optional. First name of the other party in a private chat |
| last_name | String | Optional. Last name of the other party in a private chat |
This object represents a message.
| Field | Type | Description |
| message_id | Integer | Unique message identifier |
| from | User | Optional. Sender, can be empty for messages sent to channels |
| date | Integer | Date the message was sent in Unix time |
| chat | Chat | Conversation the message belongs to |
| forward_from | User | Optional. For forwarded messages, sender of the original message |
| forward_date | Integer | Optional. For forwarded messages, date the original message was sent in Unix time |
| reply_to_message | Message | Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply. |
| text | String | Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters. |
| audio | Audio | Optional. Message is an audio file, information about the file |
| document | Document | Optional. Message is a general file, information about the file |
| photo | Array of PhotoSize | Optional. Message is a photo, available sizes of the photo |
| sticker | Sticker | Optional. Message is a sticker, information about the sticker |
| video | Video | Optional. Message is a video, information about the video |
| voice | Voice | Optional. Message is a voice message, information about the file |
| caption | String | Optional. Caption for the document, photo or video, 0-200 characters |
| contact | Contact | Optional. Message is a shared contact, information about the contact |
| location | Location | Optional. Message is a shared location, information about the location |
| new_chat_participant | User | Optional. A new member was added to the group, information about them (this member may be the bot itself) |
| left_chat_participant | User | Optional. A member was removed from the group, information about them (this member may be the bot itself) |
| new_chat_title | String | Optional. A chat title was changed to this value |
| new_chat_photo | Array of PhotoSize | Optional. A chat photo was change to this value |
| delete_chat_photo | True | Optional. Service message: the chat photo was deleted |
| group_chat_created | True | Optional. Service message: the group has been created |
| supergroup_chat_created | True | Optional. Service message: the supergroup has been created |
| channel_chat_created | True | Optional. Service message: the channel has been created |
| migrate_to_chat_id | Integer | Optional. The group has been migrated to a supergroup with the specified identifier, not exceeding 1e13 by absolute value |
| migrate_from_chat_id | Integer | Optional. The supergroup has been migrated from a group with the specified identifier, not exceeding 1e13 by absolute value |
This object represents one size of a photo or a file / sticker thumbnail.
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| width | Integer | Photo width |
| height | Integer | Photo height |
| file_size | Integer | Optional. File size |
This object represents an audio file to be treated as music by the Telegram clients.
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| duration | Integer | Duration of the audio in seconds as defined by sender |
| performer | String | Optional. Performer of the audio as defined by sender or by audio tags |
| title | String | Optional. Title of the audio as defined by sender or by audio tags |
| mime_type | String | Optional. MIME type of the file as defined by sender |
| file_size | Integer | Optional. File size |
This object represents a general file (as opposed to photos, voice messages and audio files).
| Field | Type | Description |
| file_id | String | Unique file identifier |
| thumb | PhotoSize | Optional. Document thumbnail as defined by sender |
| file_name | String | Optional. Original filename as defined by sender |
| mime_type | String | Optional. MIME type of the file as defined by sender |
| file_size | Integer | Optional. File size |
This object represents a sticker.
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| width | Integer | Sticker width |
| height | Integer | Sticker height |
| thumb | PhotoSize | Optional. Sticker thumbnail in .webp or .jpg format |
| file_size | Integer | Optional. File size |
This object represents a video file.
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| width | Integer | Video width as defined by sender |
| height | Integer | Video height as defined by sender |
| duration | Integer | Duration of the video in seconds as defined by sender |
| thumb | PhotoSize | Optional. Video thumbnail |
| mime_type | String | Optional. Mime type of a file as defined by sender |
| file_size | Integer | Optional. File size |
This object represents a voice note.
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| duration | Integer | Duration of the audio in seconds as defined by sender |
| mime_type | String | Optional. MIME type of the file as defined by sender |
| file_size | Integer | Optional. File size |
This object represents a phone contact.
| Field | Type | Description |
| phone_number | String | Contact's phone number |
| first_name | String | Contact's first name |
| last_name | String | Optional. Contact's last name |
| user_id | Integer | Optional. Contact's user identifier in Telegram |
This object represents a point on the map.
| Field | Type | Description |
| longitude | Float | Longitude as defined by sender |
| latitude | Float | Latitude as defined by sender |
This object represent a user's profile pictures.
| Field | Type | Description |
| total_count | Integer | Total number of profile pictures the target user has |
| photos | Array of Array of PhotoSize | Requested profile pictures (in up to 4 sizes each) |
This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. 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.
Maximum file size to download is 20 MB
| Field | Type | Description |
| file_id | String | Unique identifier for this file |
| file_size | Integer | Optional. File size, if known |
| file_path | String | Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. |
This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
| Field | Type | Description |
| keyboard | Array of Array of String | Array of button rows, each represented by an Array of Strings |
| resize_keyboard | Boolean | Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard. |
| one_time_keyboard | Boolean | Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false. |
| selective | Boolean | Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard. |
Upon receiving a message with this object, Telegram clients will hide the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).
| Field | Type | Description |
| hide_keyboard | True | Requests clients to hide the custom keyboard |
| selective | Boolean | Optional. Use this parameter if you want to hide keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. Example: A user votes in a poll, bot returns confirmation message in reply to the vote and hides keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet. |
Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
| Field | Type | Description |
| force_reply | True | Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply' |
| selective | Boolean | Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message. |
Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
The last option is definitely more attractive. And if you use ForceReply in your bot‘s questions, it will receive the user’s answers even if it only receives replies, commands and mentions — without any extra work for the user.
This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.
There are two ways of sending a file (photo, sticker, audio etc.). If it‘s a new file, you can upload it using multipart/form-data. If the file is already on our servers, you don’t need to reupload it: each file object has a file_id field, you can simply pass this file_id as a parameter instead.
All methods in the Bot API are case-insensitive. We support GET and POST HTTP methods. Use either URL query string or application/json or application/x-www-form-urlencoded or multipart/form-data for passing parameters in Bot API requests.
On successful call, a JSON-object containing the result will be returned.
A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.
Use this method to send text messages. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| text | String | Yes | Text of the message to be sent |
| parse_mode | String | Optional | Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
| disable_web_page_preview | Boolean | Optional | Disables link previews for links in this message |
| disable_notification | Boolean | Optional | Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply | Optional | Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. |
The Bot API supports basic formatting for messages. You can use bold and italic text, as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can use either markdown-style or HTML-style formatting.
Note that Telegram clients will display an alert to the user before opening an inline link (‘Open this link?’ together with the full URL).
To use this mode, pass Markdown in the parse_mode field when using sendMessage. Use the following syntax in your message:
*bold text*
_italic text_
[text](URL)
`inline fixed-width code`
```pre-formatted fixed-width code block```To use this mode, pass HTML in the parse_mode field when using sendMessage. The following tags are currently supported:
<b>bold</b>, <strong>bold</strong>
<i>italic</i>, <em>italic</em>
<a href="URL">inline URL</a>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>Please note:
<, > and & symbols that are not a part of a tag or an HTML entity must be replaced with the corresponding HTML entities (< with <, > with > and & with &).<, >, & and ".Use this method to forward messages of any kind. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| from_chat_id | Integer or String | Yes | Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) |
| disable_notification | Boolean | Optional | Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon. |
| message_id | Integer | Yes | Unique message identifier |
Use this method to send photos. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| photo | InputFile or String | Yes | Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo using multipart/form-data. |
| caption | String | Optional | Photo caption (may also be used when resending photos by file_id), 0-200 characters |
| disable_notification | Boolean | Optional | Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply | Optional | Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. |
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 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.
For sending voice messages, use the sendVoice method instead.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| audio | InputFile or String | Yes | Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data. |
| duration | Integer | Optional | Duration of the audio in seconds |
| performer | String | Optional | Performer |
| title | String | Optional | Track name |
| disable_notification | Boolean | Optional | Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply | Optional | Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. |
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.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| document | InputFile or String | Yes | File to send. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data. |
| caption | String | Optional | Document caption (may also be used when resending documents by file_id), 0-200 characters |
| disable_notification | Boolean | Optional | Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply | Optional | Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. |
Use this method to send .webp stickers. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| sticker | InputFile or String | Yes | Sticker to send. You can either pass a file_id as String to resend a sticker that is already on the Telegram servers, or upload a new sticker using multipart/form-data. |
| disable_notification | Boolean | Optional | Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply | Optional | Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. |
Use 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. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| video | InputFile or String | Yes | Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file using multipart/form-data. |
| duration | Integer | Optional | Duration of sent video in seconds |
| width | Integer | Optional | Video width |
| height | Integer | Optional | Video height |
| caption | String | Optional | Video caption (may also be used when resending videos by file_id), 0-200 characters |
| disable_notification | Boolean | Optional | Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply | Optional | Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. |
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 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.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| voice | InputFile or String | Yes | Audio file to send. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data. |
| duration | Integer | Optional | Duration of sent audio in seconds |
| disable_notification | Boolean | Optional | Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply | Optional | Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. |
Use this method to send point on the map. On success, the sent Message is returned.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| latitude | Float number | Yes | Latitude of location |
| longitude | Float number | Yes | Longitude of location |
| disable_notification | Boolean | Optional | Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon. |
| reply_to_message_id | Integer | Optional | If the message is a reply, ID of the original message |
| reply_markup | ReplyKeyboardMarkup or ReplyKeyboardHide or ForceReply | Optional | Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. |
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).
Example: The ImageBot 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 sendChatAction 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.
| Parameters | Type | Required | Description |
| chat_id | Integer or String | Yes | Unique identifier for the target chat or username of the target channel (in the format @channelusername) |
| action | String | Yes | Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_audio or upload_audio for audio files, upload_document for general files, find_location for location data. |
Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
| Parameters | Type | Required | Description |
| user_id | Integer | Yes | Unique identifier of the target user |
| offset | Integer | Optional | Sequential number of the first photo to be returned. By default, all photos are returned. |
| limit | Integer | Optional | Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100. |
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 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 again.
| Parameters | Type | Required | Description |
| file_id | String | Yes | File identifier to get info about |
The following methods and objects allow your bot to work in inline mode.
Please see our Introduction to Inline bots for more details.
To enable this option, send the /setinline command to @BotFather and provide the placeholder text that the user will see in the input field after typing your bot’s name.
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
| Field | Type | Description |
| id | String | Unique identifier for this query |
| from | User | Sender |
| query | String | Text of the query |
| offset | String | Offset of the results to be returned, can be controlled by the bot |
Use this method to send answers to an inline query. On success, True is returned.
No more than 50 results per query are allowed.
| Parameters | Type | Required | Description |
| inline_query_id | String | Yes | Unique identifier for the answered query |
| results | Array of InlineQueryResult | Yes | A JSON-serialized array of results for the inline query |
| cache_time | Integer | Optional | The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. |
| is_personal | Boolean | Optional | Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query |
| next_offset | String | Optional | Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes. |
This object represents one result of an inline query. Telegram clients currently support results of the following 5 types:
Represents a link to an article or web page.
| Field | Type | Description |
| type | String | Type of the result, must be article |
| id | String | Unique identifier for this result, 1-64 Bytes |
| title | String | Title of the result |
| message_text | String | Text of the message to be sent, 1-4096 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
| disable_web_page_preview | Boolean | Optional. Disables link previews for links in the sent message |
| url | String | Optional. URL of the result |
| hide_url | Boolean | Optional. Pass True, if you don't want the URL to be shown in the message |
| description | String | Optional. Short description of the result |
| thumb_url | String | Optional. Url of the thumbnail for the result |
| thumb_width | Integer | Optional. Thumbnail width |
| thumb_height | Integer | Optional. Thumbnail height |
Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can provide message_text to send it instead of photo.
| Field | Type | Description |
| type | String | Type of the result, must be photo |
| id | String | Unique identifier for this result, 1-64 bytes |
| photo_url | String | A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB |
| photo_width | Integer | Optional. Width of the photo |
| photo_height | Integer | Optional. Height of the photo |
| thumb_url | String | URL of the thumbnail for the photo |
| title | String | Optional. Title for the result |
| description | String | Optional. Short description of the result |
| caption | String | Optional. Caption of the photo to be sent, 0-200 characters |
| message_text | String | Optional. Text of a message to be sent instead of the photo, 1-4096 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
| disable_web_page_preview | Boolean | Optional. Disables link previews for links in the sent message |
Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can provide message_text to send it instead of the animation.
| Field | Type | Description |
| type | String | Type of the result, must be gif |
| id | String | Unique identifier for this result, 1-64 bytes |
| gif_url | String | A valid URL for the GIF file. File size must not exceed 1MB |
| gif_width | Integer | Optional. Width of the GIF |
| gif_height | Integer | Optional. Height of the GIF |
| thumb_url | String | URL of the static thumbnail for the result (jpeg or gif) |
| title | String | Optional. Title for the result |
| caption | String | Optional. Caption of the GIF file to be sent, 0-200 characters |
| message_text | String | Optional. Text of a message to be sent instead of the animation, 1-4096 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
| disable_web_page_preview | Boolean | Optional. Disables link previews for links in the sent message |
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can provide message_text to send it instead of the animation.
| Field | Type | Description |
| type | String | Type of the result, must be mpeg4_gif |
| id | String | Unique identifier for this result, 1-64 bytes |
| mpeg4_url | String | A valid URL for the MP4 file. File size must not exceed 1MB |
| mpeg4_width | Integer | Optional. Video width |
| mpeg4_height | Integer | Optional. Video height |
| thumb_url | String | URL of the static thumbnail (jpeg or gif) for the result |
| title | String | Optional. Title for the result |
| caption | String | Optional. Caption of the MPEG-4 file to be sent, 0-200 characters |
| message_text | String | Optional. Text of a message to be sent instead of the animation, 1-4096 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
| disable_web_page_preview | Boolean | Optional. Disables link previews for links in the sent message |
Represents link to a page containing an embedded video player or a video file.
| Field | Type | Description |
| type | String | Type of the result, must be video |
| id | String | Unique identifier for this result, 1-64 bytes |
| video_url | String | A valid URL for the embedded video player or video file |
| mime_type | String | Mime type of the content of video url, “text/html” or “video/mp4” |
| message_text | String | Text of the message to be sent with the video, 1-4096 characters |
| parse_mode | String | Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. |
| disable_web_page_preview | Boolean | Optional. Disables link previews for links in the sent message |
| video_width | Integer | Optional. Video width |
| video_height | Integer | Optional. Video height |
| video_duration | Integer | Optional. Video duration in seconds |
| thumb_url | String | URL of the thumbnail (jpeg only) for the video |
| title | String | Title for the result |
| description | String | Optional. Short description of the result |
This object represents a result of an inline query that was chosen by the user and sent to their chat partner.
| Field | Type | Description |
| result_id | String | The unique identifier for the result that was chosen. |
| from | User | The user that chose the result. |
| query | String | The query that was used to obtain the result. |
And that‘s about all we’ve got for now.
If you've got any questions, please check out our Bot FAQ »