diff --git a/testdata/html/latest.html b/testdata/html/latest.html index 4e68d24..d0fe43d 120000 --- a/testdata/html/latest.html +++ b/testdata/html/latest.html @@ -1 +1 @@ -snapshot_2026-05-20.html \ No newline at end of file +snapshot_2026-06-01.html \ No newline at end of file diff --git a/testdata/html/snapshot_2026-06-01.html b/testdata/html/snapshot_2026-06-01.html new file mode 100644 index 0000000..2b4d883 --- /dev/null +++ b/testdata/html/snapshot_2026-06-01.html @@ -0,0 +1,19872 @@ + + + + + Telegram Bot API + + + + + + + + + + + + + + + + +
+
+
+
+ + +
+
+
+
+
+
+
+

Telegram Bot API

+ +
+ +
+

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.

+
+

Recent changes

+
+

Subscribe to @BotNews to be the first to know about the latest updates and join the discussion in @BotTalk

+
+

May 8, 2026

+

Bot API 10.0

+

Guest Mode

+
    +
  • Introduced support for guest mode, allowing bots to receive certain messages and issue replies within chats they are not a member of.
    • +
  • Added the field supports_guest_queries to the class User.
    • +
  • Added the fields guest_bot_caller_user and guest_bot_caller_chat to the class Message.
    • +
  • Added the field guest_query_id to the class Message.
    • +
  • Added the field guest_message to the class Update.
    • +
  • Added the class SentGuestMessage and the method answerGuestQuery.
    • +
+

Chat Management

+ +

Polls

+
    +
  • Added the classes InputMediaSticker, InputMediaLocation, and InputMediaVenue.
    • +
  • Added the class PollMedia, representing a media in a poll.
    • +
  • Added the field media to the class Poll, allowing bots to see media in polls.
    • +
  • Added the field explanation_media to the class Poll, allowing bots to see media in quiz explanations.
    • +
  • Added the field media to the class PollOption, allowing bots to see media in poll options.
    • +
  • Added the class InputPollMedia and the parameters media and explanation_media to the method sendPoll, allowing bots to add media to polls.
    • +
  • Added the class InputPollOptionMedia and the field media to the class InputPollOption, allowing bots to add media to poll options.
    • +
  • Added the field members_only to the class Poll.
    • +
  • Added the parameter members_only to the method sendPoll.
    • +
  • Added the field country_codes to the class Poll.
    • +
  • Added the parameter country_codes to the method sendPoll.
    • +
  • Decreased the minimum number of poll options from 2 to 1.
    • +
+

Live photos

+ +

General

+ +

April 3, 2026

+

Bot API 9.6

+

Managed Bots

+ +

Polls

+
    +
  • Added support for quizzes with multiple correct answers.
    • +
  • Replaced the field correct_option_id with the field correct_option_ids in the class Poll.
    • +
  • Replaced the parameter correct_option_id with the parameter correct_option_ids in the method sendPoll.
    • +
  • Allowed to pass allows_multiple_answers for quizzes in the method sendPoll.
    • +
  • Increased the maximum time for automatic poll closure to 2628000 seconds.
    • +
  • Added the field allows_revoting to the class Poll.
    • +
  • Added the parameter allows_revoting to the method sendPoll.
    • +
  • Added the parameter shuffle_options to the method sendPoll.
    • +
  • Added the parameter allow_adding_options to the method sendPoll.
    • +
  • Added the parameter hide_results_until_closes to the method sendPoll.
    • +
  • Added the fields description and description_entities to the class Poll.
    • +
  • Added the parameters description, description_parse_mode, and description_entities to the method sendPoll.
    • +
  • Added the field persistent_id to the class PollOption, representing a persistent identifier for the option.
    • +
  • Added the field option_persistent_ids to the class PollAnswer.
    • +
  • Added the fields added_by_user and added_by_chat to the class PollOption, denoting the user and the chat which added the option.
    • +
  • Added the field addition_date to the class PollOption, describing the date when the option was added.
    • +
  • Added the class PollOptionAdded and the field poll_option_added to the class Message.
    • +
  • Added the class PollOptionDeleted and the field poll_option_deleted to the class Message.
    • +
  • Added the field poll_option_id to the class ReplyParameters, allowing bots to reply to a specific poll option.
    • +
  • Added the field reply_to_poll_option_id to the class Message.
    • +
  • Allowed “date_time” entities in checklist title, checklist task text, TextQuote, ReplyParameters quote, sendGift, and giftPremiumSubscription.
    • +
+

March 1, 2026

+

Bot API 9.5

+ +

February 9, 2026

+

Bot API 9.4

+
    +
  • Allowed bots to use custom emoji in messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
    • +
  • Allowed bots to create topics in private chats using the method createForumTopic.
    • +
  • Allowed bots to prevent users from creating and deleting topics in private chats through a new setting in the @BotFather Mini App.
    • +
  • Added the field allows_users_to_create_topics to the class User.
    • +
  • Added the field icon_custom_emoji_id to the classes KeyboardButton and InlineKeyboardButton, allowing bots to show a custom emoji on buttons if they are able to use custom emoji in the message.
    • +
  • Added the field style to the classes KeyboardButton and InlineKeyboardButton, allowing bots to change the color of buttons.
    • +
  • Added the class ChatOwnerLeft and the field chat_owner_left to the class Message.
    • +
  • Added the class ChatOwnerChanged and the field chat_owner_changed to the class Message.
    • +
  • Added the methods setMyProfilePhoto and removeMyProfilePhoto, allowing bots to manage their profile picture.
    • +
  • Added the class VideoQuality and the field qualities to the class Video allowing bots to get information about other available qualities of a video.
    • +
  • Added the field first_profile_audio to the class ChatFullInfo.
    • +
  • Added the class UserProfileAudios and the method getUserProfileAudios, allowing bots to fetch a list of audios added to the profile of a user.
    • +
  • Added the field rarity to the class UniqueGiftModel.
    • +
  • Added the field is_burned to the class UniqueGift.
    • +
+

See earlier changes »

+

Authorizing your bot

+

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.

+

Making requests

+

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/getMe
+

We support GET and POST HTTP methods. We support four ways of passing parameters in Bot API requests:

+
    +
  • URL query string
    • +
  • application/x-www-form-urlencoded
    • +
  • application/json (except for uploading files)
    • +
  • multipart/form-data (use to upload files)
    • +
+

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. Some errors may also have an optional field 'parameters' of the type ResponseParameters, which can help to automatically handle the error.

+
    +
  • All methods in the Bot API are case-insensitive.
    • +
  • All queries must be made using UTF-8.
    • +
+

Making requests when getting updates

+

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.

+
+

Using a Local Bot API Server

+

The Bot API server source code is available at telegram-bot-api. You can run it locally and send the requests to your own server instead of https://api.telegram.org. If you switch to a local Bot API server, your bot will be able to:

+
    +
  • Download files without a size limit.
    • +
  • Upload files up to 2000 MB.
    • +
  • Upload files using their local path and the file URI scheme.
    • +
  • Use an HTTP URL for the webhook.
    • +
  • Use any local IP address for the webhook.
    • +
  • Use any port for the webhook.
    • +
  • Set max_webhook_connections up to 100000.
    • +
  • Receive the absolute local path as a value of the file_path field without the need to download the file after a getFile request.
    • +
+

Do I need a Local Bot API Server

+

The majority of bots will be OK with the default configuration, running on our servers. But if you feel that you need one of these features, you're welcome to switch to your own at any time.

+

Getting updates

+

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.

+

Update

+

This object represents an incoming update.
At most one of the optional fields can be present in any given update.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
update_idIntegerThe update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This identifier 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. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.
messageMessageOptional. New incoming message of any kind - text, photo, sticker, etc.
edited_messageMessageOptional. New version of a message that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.
channel_postMessageOptional. New incoming channel post of any kind - text, photo, sticker, etc.
edited_channel_postMessageOptional. New version of a channel post that is known to the bot and was edited. This update may at times be triggered by changes to message fields that are either unavailable or not actively used by your bot.
business_connectionBusinessConnectionOptional. The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot
business_messageMessageOptional. New message from a connected business account
edited_business_messageMessageOptional. New version of a message from a connected business account
deleted_business_messagesBusinessMessagesDeletedOptional. Messages were deleted from a connected business account
guest_messageMessageOptional. New guest message. The bot can use the field Message.guest_query_id and the method answerGuestQuery to send a message in response.
message_reactionMessageReactionUpdatedOptional. A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly specify "message_reaction" in the list of allowed_updates to receive these updates. The update isn't received for reactions set by bots.
message_reaction_countMessageReactionCountUpdatedOptional. Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must explicitly specify "message_reaction_count" in the list of allowed_updates to receive these updates. The updates are grouped and can be sent with delay up to a few minutes.
inline_queryInlineQueryOptional. New incoming inline query
chosen_inline_resultChosenInlineResultOptional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.
callback_queryCallbackQueryOptional. New incoming callback query
shipping_queryShippingQueryOptional. New incoming shipping query. Only for invoices with flexible price.
pre_checkout_queryPreCheckoutQueryOptional. New incoming pre-checkout query. Contains full information about checkout.
purchased_paid_mediaPaidMediaPurchasedOptional. A user purchased paid media with a non-empty payload sent by the bot in a non-channel chat
pollPollOptional. New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot.
poll_answerPollAnswerOptional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.
my_chat_memberChatMemberUpdatedOptional. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.
chat_memberChatMemberUpdatedOptional. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify "chat_member" in the list of allowed_updates to receive these updates.
chat_join_requestChatJoinRequestOptional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.
chat_boostChatBoostUpdatedOptional. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.
removed_chat_boostChatBoostRemovedOptional. A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.
managed_botManagedBotUpdatedOptional. A new bot was created to be managed by the bot, or token or owner of a managed bot was changed
+

getUpdates

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
offsetIntegerOptionalIdentifier 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 be forgotten.
limitIntegerOptionalLimits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.
timeoutIntegerOptionalTimeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.
allowed_updatesArray of StringOptionalA JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.

Please note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time.
+
+

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.

+
+

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.

+

If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
urlStringYesHTTPS URL to send updates to. Use an empty string to remove webhook integration.
certificateInputFileOptionalUpload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.
ip_addressStringOptionalThe fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS
max_connectionsIntegerOptionalThe maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.
allowed_updatesArray of StringOptionalA JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.
Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.
drop_pending_updatesBooleanOptionalPass True to drop all pending updates
secret_tokenStringOptionalA secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.
+
+

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.

+

If you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.

+
+

deleteWebhook

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
drop_pending_updatesBooleanOptionalPass True to drop all pending updates
+

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.

+

WebhookInfo

+

Describes the current status of a webhook.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
urlStringWebhook URL, may be empty if webhook is not set up
has_custom_certificateBooleanTrue, if a custom certificate was provided for webhook certificate checks
pending_update_countIntegerNumber of updates awaiting delivery
ip_addressStringOptional. Currently used webhook IP address
last_error_dateIntegerOptional. Unix time for the most recent error that happened when trying to deliver an update via webhook
last_error_messageStringOptional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook
last_synchronization_error_dateIntegerOptional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters
max_connectionsIntegerOptional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery
allowed_updatesArray of StringOptional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member, message_reaction, and message_reaction_count.
+

Available types

+

All types used in the Bot API responses are represented as JSON-objects.

+

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.

+
+

User

+

This object represents a Telegram user or bot.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idIntegerUnique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
is_botBooleanTrue, if this user is a bot
first_nameStringUser's or bot's first name
last_nameStringOptional. User's or bot's last name
usernameStringOptional. User's or bot's username
language_codeStringOptional. IETF language tag of the user's language
is_premiumTrueOptional. True, if this user is a Telegram Premium user
added_to_attachment_menuTrueOptional. True, if this user added the bot to the attachment menu
can_join_groupsBooleanOptional. True, if the bot can be invited to groups. Returned only in getMe.
can_read_all_group_messagesBooleanOptional. True, if privacy mode is disabled for the bot. Returned only in getMe.
supports_guest_queriesBooleanOptional. True, if the bot supports guest queries from chats it is not a member of. Returned only in getMe.
supports_inline_queriesBooleanOptional. True, if the bot supports inline queries. Returned only in getMe.
can_connect_to_businessBooleanOptional. True, if the bot can be connected to a user account to manage it. Returned only in getMe.
has_main_web_appBooleanOptional. True, if the bot has a main Web App. Returned only in getMe.
has_topics_enabledBooleanOptional. True, if the bot has forum topic mode enabled in private chats. Returned only in getMe.
allows_users_to_create_topicsBooleanOptional. True, if the bot allows users to create and delete topics in private chats. Returned only in getMe.
can_manage_botsBooleanOptional. True, if other bots can be created to be controlled by the bot. Returned only in getMe.
+

Chat

+

This object represents a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idIntegerUnique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
typeStringType of the chat, can be either “private”, “group”, “supergroup” or “channel”
titleStringOptional. Title, for supergroups, channels and group chats
usernameStringOptional. Username, for private chats, supergroups and channels if available
first_nameStringOptional. First name of the other party in a private chat
last_nameStringOptional. Last name of the other party in a private chat
is_forumTrueOptional. True, if the supergroup chat is a forum (has topics enabled)
is_direct_messagesTrueOptional. True, if the chat is the direct messages chat of a channel
+

ChatFullInfo

+

This object contains full information about a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idIntegerUnique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
typeStringType of the chat, can be either “private”, “group”, “supergroup” or “channel”
titleStringOptional. Title, for supergroups, channels and group chats
usernameStringOptional. Username, for private chats, supergroups and channels if available
first_nameStringOptional. First name of the other party in a private chat
last_nameStringOptional. Last name of the other party in a private chat
is_forumTrueOptional. True, if the supergroup chat is a forum (has topics enabled)
is_direct_messagesTrueOptional. True, if the chat is the direct messages chat of a channel
accent_color_idIntegerIdentifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.
max_reaction_countIntegerThe maximum number of reactions that can be set on a message in the chat
photoChatPhotoOptional. Chat photo
active_usernamesArray of StringOptional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels
birthdateBirthdateOptional. For private chats, the date of birth of the user
business_introBusinessIntroOptional. For private chats with business accounts, the intro of the business
business_locationBusinessLocationOptional. For private chats with business accounts, the location of the business
business_opening_hoursBusinessOpeningHoursOptional. For private chats with business accounts, the opening hours of the business
personal_chatChatOptional. For private chats, the personal channel of the user
parent_chatChatOptional. Information about the corresponding channel chat; for direct messages chats only
available_reactionsArray of ReactionTypeOptional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.
background_custom_emoji_idStringOptional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background
profile_accent_color_idIntegerOptional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details.
profile_background_custom_emoji_idStringOptional. Custom emoji identifier of the emoji chosen by the chat for its profile background
emoji_status_custom_emoji_idStringOptional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat
emoji_status_expiration_dateIntegerOptional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any
bioStringOptional. Bio of the other party in a private chat
has_private_forwardsTrueOptional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user
has_restricted_voice_and_video_messagesTrueOptional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat
join_to_send_messagesTrueOptional. True, if users need to join the supergroup before they can send messages
join_by_requestTrueOptional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators
descriptionStringOptional. Description, for groups, supergroups and channel chats
invite_linkStringOptional. Primary invite link, for groups, supergroups and channel chats
pinned_messageMessageOptional. The most recent pinned message (by sending date)
permissionsChatPermissionsOptional. Default chat member permissions, for groups and supergroups
accepted_gift_typesAcceptedGiftTypesInformation about types of gifts that are accepted by the chat or by the corresponding user for private chats
can_send_paid_mediaTrueOptional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats.
slow_mode_delayIntegerOptional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds
unrestrict_boost_countIntegerOptional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions
message_auto_delete_timeIntegerOptional. The time after which all messages sent to the chat will be automatically deleted; in seconds
has_aggressive_anti_spam_enabledTrueOptional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.
has_hidden_membersTrueOptional. True, if non-administrators can only get the list of bots and administrators in the chat
has_protected_contentTrueOptional. True, if messages from the chat can't be forwarded to other chats
has_visible_historyTrueOptional. True, if new chat members will have access to old messages; available only to chat administrators
sticker_set_nameStringOptional. For supergroups, name of the group sticker set
can_set_sticker_setTrueOptional. True, if the bot can change the group sticker set
custom_emoji_sticker_set_nameStringOptional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.
linked_chat_idIntegerOptional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.
locationChatLocationOptional. For supergroups, the location to which the supergroup is connected
ratingUserRatingOptional. For private chats, the rating of the user if any
first_profile_audioAudioOptional. For private chats, the first audio added to the profile of the user
unique_gift_colorsUniqueGiftColorsOptional. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews
paid_message_star_countIntegerOptional. The number of Telegram Stars a general user has to pay to send a message to the chat
+

Message

+

This object represents a message.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
message_idIntegerUnique message identifier inside this chat. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent.
message_thread_idIntegerOptional. Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only
direct_messages_topicDirectMessagesTopicOptional. Information about the direct messages chat topic that contains the message
fromUserOptional. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats.
sender_chatChatOptional. Sender of the message when sent on behalf of a chat. For example, the supergroup itself for messages sent by its anonymous administrators or a linked channel for messages automatically forwarded to the channel's discussion group. For backward compatibility, if the message was sent on behalf of a chat, the field from contains a fake sender user in non-channel chats.
sender_boost_countIntegerOptional. If the sender of the message boosted the chat, the number of boosts added by the user
sender_business_botUserOptional. The bot that actually sent the message on behalf of the business account. Available only for outgoing messages sent on behalf of the connected business account.
sender_tagStringOptional. Tag or custom title of the sender of the message; for supergroups only
dateIntegerDate the message was sent in Unix time. It is always a positive number, representing a valid date.
guest_query_idStringOptional. The unique identifier for the guest query. Use this identifier with the method answerGuestQuery to send a response message. If non-empty, the message belongs to the chat where the guest bot was summoned, which may not coincide with other existing bot chats sharing the same identifier.
business_connection_idStringOptional. Unique identifier of the business connection from which the message was received. If non-empty, the message belongs to a chat of the corresponding business account that is independent from any potential bot chat which might share the same identifier.
chatChatChat the message belongs to
forward_originMessageOriginOptional. Information about the original message for forwarded messages
is_topic_messageTrueOptional. True, if the message is sent to a topic in a forum supergroup or a private chat with the bot
is_automatic_forwardTrueOptional. True, if the message is a channel post that was automatically forwarded to the connected discussion group
reply_to_messageMessageOptional. For replies in the same chat and message thread, 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.
external_replyExternalReplyInfoOptional. Information about the message that is being replied to, which may come from another chat or forum topic
quoteTextQuoteOptional. For replies that quote part of the original message, the quoted part of the message
reply_to_storyStoryOptional. For replies to a story, the original story
reply_to_checklist_task_idIntegerOptional. Identifier of the specific checklist task that is being replied to
reply_to_poll_option_idStringOptional. Persistent identifier of the specific poll option that is being replied to
via_botUserOptional. Bot through which the message was sent
guest_bot_caller_userUserOptional. For a message sent by a guest bot, this is the user whose original message triggered the bot's response
guest_bot_caller_chatChatOptional. For a message sent by a guest bot, this is the chat whose original message triggered the bot's response
edit_dateIntegerOptional. Date the message was last edited in Unix time
has_protected_contentTrueOptional. True, if the message can't be forwarded
is_from_offlineTrueOptional. True, if the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message
is_paid_postTrueOptional. True, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the payment and can't be edited.
media_group_idStringOptional. The unique identifier inside this chat of a media message group this message belongs to
author_signatureStringOptional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator
paid_star_countIntegerOptional. The number of Telegram Stars that were paid by the sender of the message to send it
textStringOptional. For text messages, the actual UTF-8 text of the message
entitiesArray of MessageEntityOptional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text
link_preview_optionsLinkPreviewOptionsOptional. Options used for link preview generation for the message, if it is a text message and link preview options were changed
suggested_post_infoSuggestedPostInfoOptional. Information about suggested post parameters if the message is a suggested post in a channel direct messages chat. If the message is an approved or declined suggested post, then it can't be edited.
effect_idStringOptional. Unique identifier of the message effect added to the message
animationAnimationOptional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set.
audioAudioOptional. Message is an audio file, information about the file
documentDocumentOptional. Message is a general file, information about the file
live_photoLivePhotoOptional. Message is a live photo, information about the live photo. For backward compatibility, when this field is set, the photo field will also be set.
paid_mediaPaidMediaInfoOptional. Message contains paid media; information about the paid media
photoArray of PhotoSizeOptional. Message is a photo, available sizes of the photo
stickerStickerOptional. Message is a sticker, information about the sticker
storyStoryOptional. Message is a forwarded story
videoVideoOptional. Message is a video, information about the video
video_noteVideoNoteOptional. Message is a video note, information about the video message
voiceVoiceOptional. Message is a voice message, information about the file
captionStringOptional. Caption for the animation, audio, document, paid media, photo, video or voice
caption_entitiesArray of MessageEntityOptional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
show_caption_above_mediaTrueOptional. True, if the caption must be shown above the message media
has_media_spoilerTrueOptional. True, if the message media is covered by a spoiler animation
checklistChecklistOptional. Message is a checklist
contactContactOptional. Message is a shared contact, information about the contact
diceDiceOptional. Message is a dice with random value
gameGameOptional. Message is a game, information about the game. More about games »
pollPollOptional. Message is a native poll, information about the poll
venueVenueOptional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set.
locationLocationOptional. Message is a shared location, information about the location
new_chat_membersArray of UserOptional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)
left_chat_memberUserOptional. A member was removed from the group, information about them (this member may be the bot itself)
chat_owner_leftChatOwnerLeftOptional. Service message: chat owner has left
chat_owner_changedChatOwnerChangedOptional. Service message: chat owner has changed
new_chat_titleStringOptional. A chat title was changed to this value
new_chat_photoArray of PhotoSizeOptional. A chat photo was change to this value
delete_chat_photoTrueOptional. Service message: the chat photo was deleted
group_chat_createdTrueOptional. Service message: the group has been created
supergroup_chat_createdTrueOptional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.
channel_chat_createdTrueOptional. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.
message_auto_delete_timer_changedMessageAutoDeleteTimerChangedOptional. Service message: auto-delete timer settings changed in the chat
migrate_to_chat_idIntegerOptional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
migrate_from_chat_idIntegerOptional. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
pinned_messageMaybeInaccessibleMessageOptional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
invoiceInvoiceOptional. Message is an invoice for a payment, information about the invoice. More about payments »
successful_paymentSuccessfulPaymentOptional. Message is a service message about a successful payment, information about the payment. More about payments »
refunded_paymentRefundedPaymentOptional. Message is a service message about a refunded payment, information about the payment. More about payments »
users_sharedUsersSharedOptional. Service message: users were shared with the bot
chat_sharedChatSharedOptional. Service message: a chat was shared with the bot
giftGiftInfoOptional. Service message: a regular gift was sent or received
unique_giftUniqueGiftInfoOptional. Service message: a unique gift was sent or received
gift_upgrade_sentGiftInfoOptional. Service message: upgrade of a gift was purchased after the gift was sent
connected_websiteStringOptional. The domain name of the website on which the user has logged in. More about Telegram Login »
write_access_allowedWriteAccessAllowedOptional. Service message: the user allowed the bot to write messages after adding it to the attachment or side menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess
passport_dataPassportDataOptional. Telegram Passport data
proximity_alert_triggeredProximityAlertTriggeredOptional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.
boost_addedChatBoostAddedOptional. Service message: user boosted the chat
chat_background_setChatBackgroundOptional. Service message: chat background set
checklist_tasks_doneChecklistTasksDoneOptional. Service message: some tasks in a checklist were marked as done or not done
checklist_tasks_addedChecklistTasksAddedOptional. Service message: tasks were added to a checklist
direct_message_price_changedDirectMessagePriceChangedOptional. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed
forum_topic_createdForumTopicCreatedOptional. Service message: forum topic created
forum_topic_editedForumTopicEditedOptional. Service message: forum topic edited
forum_topic_closedForumTopicClosedOptional. Service message: forum topic closed
forum_topic_reopenedForumTopicReopenedOptional. Service message: forum topic reopened
general_forum_topic_hiddenGeneralForumTopicHiddenOptional. Service message: the 'General' forum topic hidden
general_forum_topic_unhiddenGeneralForumTopicUnhiddenOptional. Service message: the 'General' forum topic unhidden
giveaway_createdGiveawayCreatedOptional. Service message: a scheduled giveaway was created
giveawayGiveawayOptional. The message is a scheduled giveaway message
giveaway_winnersGiveawayWinnersOptional. A giveaway with public winners was completed
giveaway_completedGiveawayCompletedOptional. Service message: a giveaway without public winners was completed
managed_bot_createdManagedBotCreatedOptional. Service message: user created a bot that will be managed by the current bot
paid_message_price_changedPaidMessagePriceChangedOptional. Service message: the price for paid messages has changed in the chat
poll_option_addedPollOptionAddedOptional. Service message: answer option was added to a poll
poll_option_deletedPollOptionDeletedOptional. Service message: answer option was deleted from a poll
suggested_post_approvedSuggestedPostApprovedOptional. Service message: a suggested post was approved
suggested_post_approval_failedSuggestedPostApprovalFailedOptional. Service message: approval of a suggested post has failed
suggested_post_declinedSuggestedPostDeclinedOptional. Service message: a suggested post was declined
suggested_post_paidSuggestedPostPaidOptional. Service message: payment for a suggested post was received
suggested_post_refundedSuggestedPostRefundedOptional. Service message: payment for a suggested post was refunded
video_chat_scheduledVideoChatScheduledOptional. Service message: video chat scheduled
video_chat_startedVideoChatStartedOptional. Service message: video chat started
video_chat_endedVideoChatEndedOptional. Service message: video chat ended
video_chat_participants_invitedVideoChatParticipantsInvitedOptional. Service message: new participants invited to a video chat
web_app_dataWebAppDataOptional. Service message: data sent by a Web App
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.
+

MessageId

+

This object represents a unique message identifier.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
message_idIntegerUnique message identifier. In specific instances (e.g., message containing a video sent to a big chat), the server might automatically schedule a message instead of sending it immediately. In such cases, this field will be 0 and the relevant message will be unusable until it is actually sent.
+

InaccessibleMessage

+

This object describes a message that was deleted or is otherwise inaccessible to the bot.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
chatChatChat the message belonged to
message_idIntegerUnique message identifier inside the chat
dateIntegerAlways 0. The field can be used to differentiate regular and inaccessible messages.
+

MaybeInaccessibleMessage

+

This object describes a message that can be inaccessible to the bot. It can be one of

+ +

MessageEntity

+

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag or #hashtag@chatusername), “cashtag” ($USD or $USD@chatusername), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “blockquote” (block quotation), “expandable_blockquote” (collapsed-by-default block quotation), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers), or “date_time” (for formatted date and time).
offsetIntegerOffset in UTF-16 code units to the start of the entity
lengthIntegerLength of the entity in UTF-16 code units
urlStringOptional. For “text_link” only, URL that will be opened after user taps on the text
userUserOptional. For “text_mention” only, the mentioned user
languageStringOptional. For “pre” only, the programming language of the entity text
custom_emoji_idStringOptional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker.
unix_timeIntegerOptional. For “date_time” only, the Unix time associated with the entity
date_time_formatStringOptional. For “date_time” only, the string that defines the formatting of the date and time. See date-time entity formatting for more details.
+

TextQuote

+

This object contains information about the quoted part of a message that is replied to by the given message.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
textStringText of the quoted part of a message that is replied to by the given message
entitiesArray of MessageEntityOptional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are kept in quotes.
positionIntegerApproximate quote position in the original message in UTF-16 code units as specified by the sender
is_manualTrueOptional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.
+

ExternalReplyInfo

+

This object contains information about a message that is being replied to, which may come from another chat or forum topic.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
originMessageOriginOrigin of the message replied to by the given message
chatChatOptional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel.
message_idIntegerOptional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.
link_preview_optionsLinkPreviewOptionsOptional. Options used for link preview generation for the original message, if it is a text message
animationAnimationOptional. Message is an animation, information about the animation
audioAudioOptional. Message is an audio file, information about the file
documentDocumentOptional. Message is a general file, information about the file
live_photoLivePhotoOptional. Message is a live photo, information about the live photo
paid_mediaPaidMediaInfoOptional. Message contains paid media; information about the paid media
photoArray of PhotoSizeOptional. Message is a photo, available sizes of the photo
stickerStickerOptional. Message is a sticker, information about the sticker
storyStoryOptional. Message is a forwarded story
videoVideoOptional. Message is a video, information about the video
video_noteVideoNoteOptional. Message is a video note, information about the video message
voiceVoiceOptional. Message is a voice message, information about the file
has_media_spoilerTrueOptional. True, if the message media is covered by a spoiler animation
checklistChecklistOptional. Message is a checklist
contactContactOptional. Message is a shared contact, information about the contact
diceDiceOptional. Message is a dice with random value
gameGameOptional. Message is a game, information about the game. More about games »
giveawayGiveawayOptional. Message is a scheduled giveaway, information about the giveaway
giveaway_winnersGiveawayWinnersOptional. A giveaway with public winners was completed
invoiceInvoiceOptional. Message is an invoice for a payment, information about the invoice. More about payments »
locationLocationOptional. Message is a shared location, information about the location
pollPollOptional. Message is a native poll, information about the poll
venueVenueOptional. Message is a venue, information about the venue
+

ReplyParameters

+

Describes reply parameters for the message that is being sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
message_idIntegerIdentifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified
chat_idInteger or StringOptional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the bot, supergroup or channel in the format @username. Not supported for messages sent on behalf of a business account and messages from channel direct messages chats.
allow_sending_without_replyBooleanOptional. Pass True if the message should be sent even if the specified message to be replied to is not found. Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business account.
quoteStringOptional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities. The message will fail to send if the quote isn't found in the original message.
quote_parse_modeStringOptional. Mode for parsing entities in the quote. See formatting options for more details.
quote_entitiesArray of MessageEntityOptional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode.
quote_positionIntegerOptional. Position of the quote in the original message in UTF-16 code units
checklist_task_idIntegerOptional. Identifier of the specific checklist task to be replied to
poll_option_idStringOptional. Persistent identifier of the specific poll option to be replied to
+

MessageOrigin

+

This object describes the origin of a message. It can be one of

+ +

MessageOriginUser

+

The message was originally sent by a known user.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the message origin, always “user”
dateIntegerDate the message was sent originally in Unix time
sender_userUserUser that sent the message originally
+

MessageOriginHiddenUser

+

The message was originally sent by an unknown user.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the message origin, always “hidden_user”
dateIntegerDate the message was sent originally in Unix time
sender_user_nameStringName of the user that sent the message originally
+

MessageOriginChat

+

The message was originally sent on behalf of a chat to a group chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the message origin, always “chat”
dateIntegerDate the message was sent originally in Unix time
sender_chatChatChat that sent the message originally
author_signatureStringOptional. For messages originally sent by an anonymous chat administrator, original message author signature
+

MessageOriginChannel

+

The message was originally sent to a channel chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the message origin, always “channel”
dateIntegerDate the message was sent originally in Unix time
chatChatChannel chat to which the message was originally sent
message_idIntegerUnique message identifier inside the chat
author_signatureStringOptional. Signature of the original post author
+

PhotoSize

+

This object represents one size of a photo or a file / sticker thumbnail.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
widthIntegerPhoto width
heightIntegerPhoto height
file_sizeIntegerOptional. File size in bytes
+

Animation

+

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
widthIntegerVideo width as defined by the sender
heightIntegerVideo height as defined by the sender
durationIntegerDuration of the video in seconds as defined by the sender
thumbnailPhotoSizeOptional. Animation thumbnail as defined by the sender
file_nameStringOptional. Original animation filename as defined by the sender
mime_typeStringOptional. MIME type of the file as defined by the sender
file_sizeIntegerOptional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
+

Audio

+

This object represents an audio file to be treated as music by the Telegram clients.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
durationIntegerDuration of the audio in seconds as defined by the sender
performerStringOptional. Performer of the audio as defined by the sender or by audio tags
titleStringOptional. Title of the audio as defined by the sender or by audio tags
file_nameStringOptional. Original filename as defined by the sender
mime_typeStringOptional. MIME type of the file as defined by the sender
file_sizeIntegerOptional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
thumbnailPhotoSizeOptional. Thumbnail of the album cover to which the music file belongs
+

Document

+

This object represents a general file (as opposed to photos, voice messages and audio files).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
thumbnailPhotoSizeOptional. Document thumbnail as defined by the sender
file_nameStringOptional. Original filename as defined by the sender
mime_typeStringOptional. MIME type of the file as defined by the sender
file_sizeIntegerOptional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
+

LivePhoto

+

This object represents a live photo.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
photoArray of PhotoSizeOptional. Available sizes of the corresponding static photo
file_idStringIdentifier for the video file which can be used to download or reuse the file
file_unique_idStringUnique identifier for the video file which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
widthIntegerVideo width as defined by the sender
heightIntegerVideo height as defined by the sender
durationIntegerDuration of the video in seconds as defined by the sender
mime_typeStringOptional. MIME type of the file as defined by the sender
file_sizeIntegerOptional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
+

Story

+

This object represents a story.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
chatChatChat that posted the story
idIntegerUnique identifier for the story in the chat
+

VideoQuality

+

This object represents a video file of a specific quality.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
widthIntegerVideo width
heightIntegerVideo height
codecStringCodec that was used to encode the video, for example, “h264”, “h265”, or “av01”
file_sizeIntegerOptional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
+

Video

+

This object represents a video file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
widthIntegerVideo width as defined by the sender
heightIntegerVideo height as defined by the sender
durationIntegerDuration of the video in seconds as defined by the sender
thumbnailPhotoSizeOptional. Video thumbnail
coverArray of PhotoSizeOptional. Available sizes of the cover of the video in the message
start_timestampIntegerOptional. Timestamp in seconds from which the video will play in the message
qualitiesArray of VideoQualityOptional. List of available qualities of the video
file_nameStringOptional. Original filename as defined by the sender
mime_typeStringOptional. MIME type of the file as defined by the sender
file_sizeIntegerOptional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
+

VideoNote

+

This object represents a video message (available in Telegram apps as of v.4.0).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
lengthIntegerVideo width and height (diameter of the video message) as defined by the sender
durationIntegerDuration of the video in seconds as defined by the sender
thumbnailPhotoSizeOptional. Video thumbnail
file_sizeIntegerOptional. File size in bytes
+

Voice

+

This object represents a voice note.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
durationIntegerDuration of the audio in seconds as defined by the sender
mime_typeStringOptional. MIME type of the file as defined by the sender
file_sizeIntegerOptional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
+

PaidMediaInfo

+

Describes the paid media added to a message.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
star_countIntegerThe number of Telegram Stars that must be paid to buy access to the media
paid_mediaArray of PaidMediaInformation about the paid media
+

PaidMedia

+

This object describes paid media. Currently, it can be one of

+ +

PaidMediaLivePhoto

+

The paid media is a live photo.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the paid media, always “live_photo”
live_photoLivePhotoThe photo
+

PaidMediaPhoto

+

The paid media is a photo.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the paid media, always “photo”
photoArray of PhotoSizeThe photo
+

PaidMediaPreview

+

The paid media isn't available before the payment.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the paid media, always “preview”
widthIntegerOptional. Media width as defined by the sender
heightIntegerOptional. Media height as defined by the sender
durationIntegerOptional. Duration of the media in seconds as defined by the sender
+

PaidMediaVideo

+

The paid media is a video.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the paid media, always “video”
videoVideoThe video
+

Contact

+

This object represents a phone contact.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
phone_numberStringContact's phone number
first_nameStringContact's first name
last_nameStringOptional. Contact's last name
user_idIntegerOptional. Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
vcardStringOptional. Additional data about the contact in the form of a vCard
+

Dice

+

This object represents an animated emoji that displays a random value.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
emojiStringEmoji on which the dice throw animation is based
valueIntegerValue of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emoji
+

PollMedia

+

At most one of the optional fields can be present in any given object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
animationAnimationOptional. Media is an animation, information about the animation
audioAudioOptional. Media is an audio file, information about the file; currently, can't be received in a poll option
documentDocumentOptional. Media is a general file, information about the file; currently, can't be received in a poll option
live_photoLivePhotoOptional. Media is a live photo, information about the live photo
locationLocationOptional. Media is a shared location, information about the location
photoArray of PhotoSizeOptional. Media is a photo, available sizes of the photo
stickerStickerOptional. Media is a sticker, information about the sticker; currently, for poll options only
venueVenueOptional. Media is a venue, information about the venue
videoVideoOptional. Media is a video, information about the video
+

InputPollMedia

+

This object represents the content of a poll description or a quiz explanation to be sent. It should be one of

+ +

InputPollOptionMedia

+

This object represents the content of a poll option to be sent. It should be one of

+ +

PollOption

+

This object contains information about one answer option in a poll.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
persistent_idStringUnique identifier of the option, persistent on option addition and deletion
textStringOption text, 1-100 characters
text_entitiesArray of MessageEntityOptional. Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts
mediaPollMediaOptional. Media added to the poll option
voter_countIntegerNumber of users who voted for this option; may be 0 if unknown
added_by_userUserOptional. User who added the option; omitted if the option wasn't added by a user after poll creation
added_by_chatChatOptional. Chat that added the option; omitted if the option wasn't added by a chat after poll creation
addition_dateIntegerOptional. Point in time (Unix timestamp) when the option was added; omitted if the option existed in the original poll
+

InputPollOption

+

This object contains information about one answer option in a poll to be sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
textStringOption text, 1-100 characters
text_parse_modeStringOptional. Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed.
text_entitiesArray of MessageEntityOptional. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode.
mediaInputPollOptionMediaOptional. Media added to the poll option
+

PollAnswer

+

This object represents an answer of a user in a non-anonymous poll.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
poll_idStringUnique poll identifier
voter_chatChatOptional. The chat that changed the answer to the poll, if the voter is anonymous
userUserOptional. The user that changed the answer to the poll, if the voter isn't anonymous
option_idsArray of Integer0-based identifiers of chosen answer options. May be empty if the vote was retracted.
option_persistent_idsArray of StringPersistent identifiers of the chosen answer options. May be empty if the vote was retracted.
+

Poll

+

This object contains information about a poll.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idStringUnique poll identifier
questionStringPoll question, 1-300 characters
question_entitiesArray of MessageEntityOptional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions
optionsArray of PollOptionList of poll options
total_voter_countIntegerTotal number of users that voted in the poll
is_closedBooleanTrue, if the poll is closed
is_anonymousBooleanTrue, if the poll is anonymous
typeStringPoll type, currently can be “regular” or “quiz”
allows_multiple_answersBooleanTrue, if the poll allows multiple answers
allows_revotingBooleanTrue, if the poll allows to change the chosen answer options
members_onlyBooleanTrue if voting is limited to users who have been members of the chat where the poll was originally sent for more than 24 hours
country_codesArray of StringOptional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll. The country code “FT” is used for users with anonymous numbers. If omitted, then users from any country can participate in the poll.
correct_option_idsArray of IntegerOptional. Array of 0-based identifiers of the correct answer options. Available only for polls in quiz mode which are closed or were sent (not forwarded) by the bot or to the private chat with the bot.
explanationStringOptional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters
explanation_entitiesArray of MessageEntityOptional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation
explanation_mediaPollMediaOptional. Media added to the quiz explanation
open_periodIntegerOptional. Amount of time in seconds the poll will be active after creation
close_dateIntegerOptional. Point in time (Unix timestamp) when the poll will be automatically closed
descriptionStringOptional. Description of the poll; for polls inside the Message object only
description_entitiesArray of MessageEntityOptional. Special entities like usernames, URLs, bot commands, etc. that appear in the description
mediaPollMediaOptional. Media added to the poll description; for polls inside the Message object only
+

ChecklistTask

+

Describes a task in a checklist.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idIntegerUnique identifier of the task
textStringText of the task
text_entitiesArray of MessageEntityOptional. Special entities that appear in the task text
completed_by_userUserOptional. User that completed the task; omitted if the task wasn't completed by a user
completed_by_chatChatOptional. Chat that completed the task; omitted if the task wasn't completed by a chat
completion_dateIntegerOptional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed
+

Checklist

+

Describes a checklist.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
titleStringTitle of the checklist
title_entitiesArray of MessageEntityOptional. Special entities that appear in the checklist title
tasksArray of ChecklistTaskList of tasks in the checklist
others_can_add_tasksTrueOptional. True, if users other than the creator of the list can add tasks to the list
others_can_mark_tasks_as_doneTrueOptional. True, if users other than the creator of the list can mark tasks as done or not done
+

InputChecklistTask

+

Describes a task to add to a checklist.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idIntegerUnique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist
textStringText of the task; 1-100 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the text. See formatting options for more details.
text_entitiesArray of MessageEntityOptional. List of special entities that appear in the text, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are allowed.
+

InputChecklist

+

Describes a checklist to create.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
titleStringTitle of the checklist; 1-255 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the title. See formatting options for more details.
title_entitiesArray of MessageEntityOptional. List of special entities that appear in the title, which can be specified instead of parse_mode. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are allowed.
tasksArray of InputChecklistTaskList of 1-30 tasks in the checklist
others_can_add_tasksBooleanOptional. Pass True if other users can add tasks to the checklist
others_can_mark_tasks_as_doneBooleanOptional. Pass True if other users can mark tasks as done or not done in the checklist
+

ChecklistTasksDone

+

Describes a service message about checklist tasks marked as done or not done.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
checklist_messageMessageOptional. Message containing the checklist whose tasks were marked as done or not done. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
marked_as_done_task_idsArray of IntegerOptional. Identifiers of the tasks that were marked as done
marked_as_not_done_task_idsArray of IntegerOptional. Identifiers of the tasks that were marked as not done
+

ChecklistTasksAdded

+

Describes a service message about tasks added to a checklist.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
checklist_messageMessageOptional. Message containing the checklist to which the tasks were added. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
tasksArray of ChecklistTaskList of tasks added to the checklist
+

Location

+

This object represents a point on the map.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
latitudeFloatLatitude as defined by the sender
longitudeFloatLongitude as defined by the sender
horizontal_accuracyFloatOptional. The radius of uncertainty for the location, measured in meters; 0-1500
live_periodIntegerOptional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.
headingIntegerOptional. The direction in which user is moving, in degrees; 1-360. For active live locations only.
proximity_alert_radiusIntegerOptional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.
+

Venue

+

This object represents a venue.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
locationLocationVenue location. Can't be a live location.
titleStringName of the venue
addressStringAddress of the venue
foursquare_idStringOptional. Foursquare identifier of the venue
foursquare_typeStringOptional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
google_place_idStringOptional. Google Places identifier of the venue
google_place_typeStringOptional. Google Places type of the venue. (See supported types.)
+

WebAppData

+

Describes data sent from a Web App to the bot.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
dataStringThe data. Be aware that a bad client can send arbitrary data in this field.
button_textStringText of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.
+

ProximityAlertTriggered

+

This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
travelerUserUser that triggered the alert
watcherUserUser that set the alert
distanceIntegerThe distance between the users
+

MessageAutoDeleteTimerChanged

+

This object represents a service message about a change in auto-delete timer settings.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
message_auto_delete_timeIntegerNew auto-delete time for messages in the chat; in seconds
+

ManagedBotCreated

+

This object contains information about the bot that was created to be managed by the current bot.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
botUserInformation about the bot. The bot's token can be fetched using the method getManagedBotToken.
+

ManagedBotUpdated

+

This object contains information about the creation, token update, or owner update of a bot that is managed by the current bot.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
userUserUser that created the bot
botUserInformation about the bot. Token of the bot can be fetched using the method getManagedBotToken.
+

PollOptionAdded

+

Describes a service message about an option added to a poll.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
poll_messageMaybeInaccessibleMessageOptional. Message containing the poll to which the option was added, if known. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
option_persistent_idStringUnique identifier of the added option
option_textStringOption text
option_text_entitiesArray of MessageEntityOptional. Special entities that appear in the option_text
+

PollOptionDeleted

+

Describes a service message about an option deleted from a poll.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
poll_messageMaybeInaccessibleMessageOptional. Message containing the poll from which the option was deleted, if known. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
option_persistent_idStringUnique identifier of the deleted option
option_textStringOption text
option_text_entitiesArray of MessageEntityOptional. Special entities that appear in the option_text
+

ChatBoostAdded

+

This object represents a service message about a user boosting a chat.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
boost_countIntegerNumber of boosts added by the user
+

BackgroundFill

+

This object describes the way a background is filled based on the selected colors. Currently, it can be one of

+ +

BackgroundFillSolid

+

The background is filled using the selected color.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the background fill, always “solid”
colorIntegerThe color of the background fill in the RGB24 format
+

BackgroundFillGradient

+

The background is a gradient fill.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the background fill, always “gradient”
top_colorIntegerTop color of the gradient in the RGB24 format
bottom_colorIntegerBottom color of the gradient in the RGB24 format
rotation_angleIntegerClockwise rotation angle of the background fill in degrees; 0-359
+

BackgroundFillFreeformGradient

+

The background is a freeform gradient that rotates after every message in the chat.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the background fill, always “freeform_gradient”
colorsArray of IntegerA list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format
+

BackgroundType

+

This object describes the type of a background. Currently, it can be one of

+ +

BackgroundTypeFill

+

The background is automatically filled based on the selected colors.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the background, always “fill”
fillBackgroundFillThe background fill
dark_theme_dimmingIntegerDimming of the background in dark themes, as a percentage; 0-100
+

BackgroundTypeWallpaper

+

The background is a wallpaper in the JPEG format.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the background, always “wallpaper”
documentDocumentDocument with the wallpaper
dark_theme_dimmingIntegerDimming of the background in dark themes, as a percentage; 0-100
is_blurredTrueOptional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12
is_movingTrueOptional. True, if the background moves slightly when the device is tilted
+

BackgroundTypePattern

+

The background is a .PNG or .TGV (gzipped subset of SVG with MIME type “application/x-tgwallpattern”) pattern to be combined with the background fill chosen by the user.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the background, always “pattern”
documentDocumentDocument with the pattern
fillBackgroundFillThe background fill that is combined with the pattern
intensityIntegerIntensity of the pattern when it is shown above the filled background; 0-100
is_invertedTrueOptional. True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only.
is_movingTrueOptional. True, if the background moves slightly when the device is tilted
+

BackgroundTypeChatTheme

+

The background is taken directly from a built-in chat theme.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the background, always “chat_theme”
theme_nameStringName of the chat theme, which is usually an emoji
+

ChatBackground

+

This object represents a chat background.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeBackgroundTypeType of the background
+

ForumTopicCreated

+

This object represents a service message about a new forum topic created in the chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
nameStringName of the topic
icon_colorIntegerColor of the topic icon in RGB format
icon_custom_emoji_idStringOptional. Unique identifier of the custom emoji shown as the topic icon
is_name_implicitTrueOptional. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot
+

ForumTopicClosed

+

This object represents a service message about a forum topic closed in the chat. Currently holds no information.

+

ForumTopicEdited

+

This object represents a service message about an edited forum topic.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
nameStringOptional. New name of the topic, if it was edited
icon_custom_emoji_idStringOptional. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon was removed
+

ForumTopicReopened

+

This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

+

GeneralForumTopicHidden

+

This object represents a service message about General forum topic hidden in the chat. Currently holds no information.

+

GeneralForumTopicUnhidden

+

This object represents a service message about General forum topic unhidden in the chat. Currently holds no information.

+

SharedUser

+

This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
user_idIntegerIdentifier of the shared user. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so 64-bit integers or double-precision float types are safe for storing these identifiers. The bot may not have access to the user and could be unable to use this identifier, unless the user is already known to the bot by some other means.
first_nameStringOptional. First name of the user, if the name was requested by the bot
last_nameStringOptional. Last name of the user, if the name was requested by the bot
usernameStringOptional. Username of the user, if the username was requested by the bot
photoArray of PhotoSizeOptional. Available sizes of the chat photo, if the photo was requested by the bot
+

UsersShared

+

This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
request_idIntegerIdentifier of the request
usersArray of SharedUserInformation about users shared with the bot
+

ChatShared

+

This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
request_idIntegerIdentifier of the request
chat_idIntegerIdentifier of the shared chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.
titleStringOptional. Title of the chat, if the title was requested by the bot
usernameStringOptional. Username of the chat, if the username was requested by the bot and available
photoArray of PhotoSizeOptional. Available sizes of the chat photo, if the photo was requested by the bot
+

WriteAccessAllowed

+

This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
from_requestBooleanOptional. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess
web_app_nameStringOptional. Name of the Web App, if the access was granted when the Web App was launched from a link
from_attachment_menuBooleanOptional. True, if the access was granted when the bot was added to the attachment or side menu
+

VideoChatScheduled

+

This object represents a service message about a video chat scheduled in the chat.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
start_dateIntegerPoint in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator
+

VideoChatStarted

+

This object represents a service message about a video chat started in the chat. Currently holds no information.

+

VideoChatEnded

+

This object represents a service message about a video chat ended in the chat.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
durationIntegerVideo chat duration in seconds
+

VideoChatParticipantsInvited

+

This object represents a service message about new members invited to a video chat.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
usersArray of UserNew members that were invited to the video chat
+

PaidMessagePriceChanged

+

Describes a service message about a change in the price of paid messages within a chat.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
paid_message_star_countIntegerThe new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message
+

DirectMessagePriceChanged

+

Describes a service message about a change in the price of direct messages sent to a channel chat.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
are_direct_messages_enabledBooleanTrue, if direct messages are enabled for the channel chat; false otherwise
direct_message_star_countIntegerOptional. The new number of Telegram Stars that must be paid by users for each direct message sent to the channel. Does not apply to users who have been exempted by administrators. Defaults to 0.
+

SuggestedPostApproved

+

Describes a service message about the approval of a suggested post.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
suggested_post_messageMessageOptional. Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
priceSuggestedPostPriceOptional. Amount paid for the post
send_dateIntegerDate when the post will be published
+

SuggestedPostApprovalFailed

+

Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient user funds at the time of approval.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
suggested_post_messageMessageOptional. Message containing the suggested post whose approval has failed. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
priceSuggestedPostPriceExpected price of the post
+

SuggestedPostDeclined

+

Describes a service message about the rejection of a suggested post.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
suggested_post_messageMessageOptional. Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
commentStringOptional. Comment with which the post was declined
+

SuggestedPostPaid

+

Describes a service message about a successful payment for a suggested post.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
suggested_post_messageMessageOptional. Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
currencyStringCurrency in which the payment was made. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins.
amountIntegerOptional. The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only
star_amountStarAmountOptional. The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only
+

SuggestedPostRefunded

+

Describes a service message about a payment refund for a suggested post.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
suggested_post_messageMessageOptional. Message containing the suggested post. Note that the Message object in this field will not contain the reply_to_message field even if it itself is a reply.
reasonStringReason for the refund. Currently, one of “post_deleted” if the post was deleted within 24 hours of being posted or removed from scheduled messages without being posted, or “payment_refunded” if the payer refunded their payment.
+

GiveawayCreated

+

This object represents a service message about the creation of a scheduled giveaway.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
prize_star_countIntegerOptional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
+

Giveaway

+

This object represents a message about a scheduled giveaway.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
chatsArray of ChatThe list of chats which the user must join to participate in the giveaway
winners_selection_dateIntegerPoint in time (Unix timestamp) when winners of the giveaway will be selected
winner_countIntegerThe number of users which are supposed to be selected as winners of the giveaway
only_new_membersTrueOptional. True, if only users who join the chats after the giveaway started should be eligible to win
has_public_winnersTrueOptional. True, if the list of giveaway winners will be visible to everyone
prize_descriptionStringOptional. Description of additional giveaway prize
country_codesArray of StringOptional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways.
prize_star_countIntegerOptional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
premium_subscription_month_countIntegerOptional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only
+

GiveawayWinners

+

This object represents a message about the completion of a giveaway with public winners.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
chatChatThe chat that created the giveaway
giveaway_message_idIntegerIdentifier of the message with the giveaway in the chat
winners_selection_dateIntegerPoint in time (Unix timestamp) when winners of the giveaway were selected
winner_countIntegerTotal number of winners in the giveaway
winnersArray of UserList of up to 100 winners of the giveaway
additional_chat_countIntegerOptional. The number of other chats the user had to join in order to be eligible for the giveaway
prize_star_countIntegerOptional. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only
premium_subscription_month_countIntegerOptional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only
unclaimed_prize_countIntegerOptional. Number of undistributed prizes
only_new_membersTrueOptional. True, if only users who had joined the chats after the giveaway started were eligible to win
was_refundedTrueOptional. True, if the giveaway was canceled because the payment for it was refunded
prize_descriptionStringOptional. Description of additional giveaway prize
+

GiveawayCompleted

+

This object represents a service message about the completion of a giveaway without public winners.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
winner_countIntegerNumber of winners in the giveaway
unclaimed_prize_countIntegerOptional. Number of undistributed prizes
giveaway_messageMessageOptional. Message with the giveaway that was completed, if it wasn't deleted
is_star_giveawayTrueOptional. True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.
+

LinkPreviewOptions

+

Describes the options used for link preview generation.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
is_disabledBooleanOptional. True, if the link preview is disabled
urlStringOptional. URL to use for the link preview. If empty, then the first URL found in the message text will be used.
prefer_small_mediaBooleanOptional. True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview
prefer_large_mediaBooleanOptional. True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly specified or media size change isn't supported for the preview
show_above_textBooleanOptional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text
+

SuggestedPostPrice

+

Describes the price of a suggested post.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
currencyStringCurrency in which the post will be paid. Currently, must be one of “XTR” for Telegram Stars or “TON” for toncoins.
amountIntegerThe amount of the currency that will be paid for the post in the smallest units of the currency, i.e. Telegram Stars or nanotoncoins. Currently, price in Telegram Stars must be between 5 and 100000, and price in nanotoncoins must be between 10000000 and 10000000000000.
+

SuggestedPostInfo

+

Contains information about a suggested post.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
stateStringState of the suggested post. Currently, it can be one of “pending”, “approved”, “declined”.
priceSuggestedPostPriceOptional. Proposed price of the post. If the field is omitted, then the post is unpaid.
send_dateIntegerOptional. Proposed send date of the post. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user or administrator who approves it.
+

SuggestedPostParameters

+

Contains parameters of a post that is being suggested by the bot.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
priceSuggestedPostPriceOptional. Proposed price for the post. If the field is omitted, then the post is unpaid.
send_dateIntegerOptional. Proposed send date of the post. If specified, then the date must be between 300 second and 2678400 seconds (30 days) in the future. If the field is omitted, then the post can be published at any time within 30 days at the sole discretion of the user who approves it.
+

DirectMessagesTopic

+

Describes a topic of a direct messages chat.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
topic_idIntegerUnique identifier of the topic. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
userUserOptional. Information about the user that created the topic. Currently, it is always present.
+

UserProfilePhotos

+

This object represent a user's profile pictures.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
total_countIntegerTotal number of profile pictures the target user has
photosArray of Array of PhotoSizeRequested profile pictures (in up to 4 sizes each)
+

UserProfileAudios

+

This object represents the audios displayed on a user's profile.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
total_countIntegerTotal number of profile audios for the target user
audiosArray of AudioRequested profile audios
+

File

+

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.

+
+

The maximum file size to download is 20 MB

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
file_sizeIntegerOptional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
file_pathStringOptional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.
+

WebAppInfo

+

Describes a Web App.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
urlStringAn HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps
+

ReplyKeyboardMarkup

+

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not supported in channels and for messages sent on behalf of a business account.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
keyboardArray of Array of KeyboardButtonArray of button rows, each represented by an Array of KeyboardButton objects
is_persistentBooleanOptional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.
resize_keyboardBooleanOptional. 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_keyboardBooleanOptional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
input_field_placeholderStringOptional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters
selectiveBooleanOptional. 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 to a message in the same chat and forum topic, 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.
+

KeyboardButton

+

This object represents one button of the reply keyboard. At most one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button. For simple text buttons, String can be used instead of this object to specify the button text.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
textStringText of the button. If none of the fields other than text, icon_custom_emoji_id, and style are used, it will be sent as a message when the button is pressed.
icon_custom_emoji_idStringOptional. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
styleStringOptional. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used.
request_usersKeyboardButtonRequestUsersOptional. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in private chats only.
request_chatKeyboardButtonRequestChatOptional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only.
request_managed_botKeyboardButtonRequestManagedBotOptional. If specified, pressing the button will ask the user to create and share a bot that will be managed by the current bot. Available for bots that enabled management of other bots in the @BotFather Mini App. Available in private chats only.
request_contactBooleanOptional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.
request_locationBooleanOptional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.
request_pollKeyboardButtonPollTypeOptional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.
web_appWebAppInfoOptional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.
+

KeyboardButtonRequestUsers

+

This object defines the criteria used to request suitable users. Information about the selected users will be shared with the bot when the corresponding button is pressed. More about requesting users »

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
request_idIntegerSigned 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message.
user_is_botBooleanOptional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied.
user_is_premiumBooleanOptional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.
max_quantityIntegerOptional. The maximum number of users to be selected; 1-10. Defaults to 1.
request_nameBooleanOptional. Pass True to request the users' first and last names
request_usernameBooleanOptional. Pass True to request the users' usernames
request_photoBooleanOptional. Pass True to request the users' photos
+

KeyboardButtonRequestChat

+

This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if appropriate. More about requesting chats ».

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
request_idIntegerSigned 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message.
chat_is_channelBooleanPass True to request a channel chat, pass False to request a group or a supergroup chat
chat_is_forumBooleanOptional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.
chat_has_usernameBooleanOptional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a username. If not specified, no additional restrictions are applied.
chat_is_createdBooleanOptional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.
user_administrator_rightsChatAdministratorRightsOptional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.
bot_administrator_rightsChatAdministratorRightsOptional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.
bot_is_memberBooleanOptional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.
request_titleBooleanOptional. Pass True to request the chat's title
request_usernameBooleanOptional. Pass True to request the chat's username
request_photoBooleanOptional. Pass True to request the chat's photo
+

KeyboardButtonRequestManagedBot

+

This object defines the parameters for the creation of a managed bot. Information about the created bot will be shared with the bot using the update managed_bot and a Message with the field managed_bot_created.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
request_idIntegerSigned 32-bit identifier of the request. Must be unique within the message.
suggested_nameStringOptional. Suggested name for the bot
suggested_usernameStringOptional. Suggested username for the bot
+

KeyboardButtonPollType

+

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringOptional. If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.
+

ReplyKeyboardRemove

+

Upon receiving a message with this object, Telegram clients will remove 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). Not supported in channels and for messages sent on behalf of a business account.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
remove_keyboardTrueRequests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)
selectiveBooleanOptional. Use this parameter if you want to remove the 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 to a message in the same chat and forum topic, sender of the original message.

Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.
+

InlineKeyboardMarkup

+

This object represents an inline keyboard that appears right next to the message it belongs to.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
inline_keyboardArray of Array of InlineKeyboardButtonArray of button rows, each represented by an Array of InlineKeyboardButton objects
+

InlineKeyboardButton

+

This object represents one button of an inline keyboard. Exactly one of the fields other than text, icon_custom_emoji_id, and style must be used to specify the type of the button.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
textStringLabel text on the button
icon_custom_emoji_idStringOptional. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
styleStringOptional. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used.
urlStringOptional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.
callback_dataStringOptional. Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes
web_appWebAppInfoOptional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a business account.
login_urlLoginUrlOptional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
switch_inline_queryStringOptional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent in channel direct messages chats and on behalf of a business account.
switch_inline_query_current_chatStringOptional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.

This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent in channel direct messages chats and on behalf of a business account.
switch_inline_query_chosen_chatSwitchInlineQueryChosenChatOptional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent in channel direct messages chats and on behalf of a business account.
copy_textCopyTextButtonOptional. Description of the button that copies the specified text to the clipboard
callback_gameCallbackGameOptional. Description of the game that will be launched when the user presses the button.

NOTE: This type of button must always be the first button in the first row.
payBooleanOptional. Specify True, to send a Pay button. Substrings “⭐” and “XTR” in the buttons's text will be replaced with a Telegram Star icon.

NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.
+

LoginUrl

+

This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in:

+
+ TITLE +
+ +

Telegram apps support these buttons as of version 5.7.

+
+

Sample bot: @discussbot

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
urlStringAn HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.

NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization.
forward_textStringOptional. New text of the button in forwarded messages
bot_usernameStringOptional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.
request_write_accessBooleanOptional. Pass True to request the permission for your bot to send messages to the user
+

SwitchInlineQueryChosenChat

+

This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
queryStringOptional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted.
allow_user_chatsBooleanOptional. True, if private chats with users can be chosen
allow_bot_chatsBooleanOptional. True, if private chats with bots can be chosen
allow_group_chatsBooleanOptional. True, if group and supergroup chats can be chosen
allow_channel_chatsBooleanOptional. True, if channel chats can be chosen
+

CopyTextButton

+

This object represents an inline keyboard button that copies specified text to the clipboard.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
textStringThe text to be copied to the clipboard; 1-256 characters
+

CallbackQuery

+

This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idStringUnique identifier for this query
fromUserSender
messageMaybeInaccessibleMessageOptional. Message sent by the bot with the callback button that originated the query
inline_message_idStringOptional. Identifier of the message sent via the bot in inline mode, that originated the query
chat_instanceStringGlobal identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.
dataStringOptional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.
game_short_nameStringOptional. Short name of a Game to be returned, serves as the unique identifier for the game
+
+

NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).

+
+

ForceReply

+

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. Not supported in channels and for messages sent on behalf of a user account.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
force_replyTrueShows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'
input_field_placeholderStringOptional. The placeholder to be shown in the input field when the reply is active; 1-64 characters
selectiveBooleanOptional. 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 to a message in the same chat and forum topic, 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:

+
    +
  • Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.
    • +
  • Guide the user through a step-by-step process. 'Please send me your question', 'Cool, now let's add the first answer option', 'Great. Keep adding answer options, then send /done when you're ready'.
    • +
+

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.

+
+

ChatPhoto

+

This object represents a chat photo.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
small_file_idStringFile identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.
small_file_unique_idStringUnique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
big_file_idStringFile identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.
big_file_unique_idStringUnique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
+

ChatInviteLink

+

Represents an invite link for a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
invite_linkStringThe invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.
creatorUserCreator of the link
creates_join_requestBooleanTrue, if users joining the chat via the link need to be approved by chat administrators
is_primaryBooleanTrue, if the link is primary
is_revokedBooleanTrue, if the link is revoked
nameStringOptional. Invite link name
expire_dateIntegerOptional. Point in time (Unix timestamp) when the link will expire or has been expired
member_limitIntegerOptional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
pending_join_request_countIntegerOptional. Number of pending join requests created using this link
subscription_periodIntegerOptional. The number of seconds the subscription will be active for before the next payment
subscription_priceIntegerOptional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link
+

ChatAdministratorRights

+

Represents the rights of an administrator in a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
is_anonymousBooleanTrue, if the user's presence in the chat is hidden
can_manage_chatBooleanTrue, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.
can_delete_messagesBooleanTrue, if the administrator can delete messages of other users
can_manage_video_chatsBooleanTrue, if the administrator can manage video chats
can_restrict_membersBooleanTrue, if the administrator can restrict, ban or unban chat members, or access supergroup statistics
can_promote_membersBooleanTrue, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)
can_change_infoBooleanTrue, if the user is allowed to change the chat title, photo and other settings
can_invite_usersBooleanTrue, if the user is allowed to invite new users to the chat
can_post_storiesBooleanTrue, if the administrator can post stories to the chat
can_edit_storiesBooleanTrue, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
can_delete_storiesBooleanTrue, if the administrator can delete stories posted by other users
can_post_messagesBooleanOptional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only
can_edit_messagesBooleanOptional. True, if the administrator can edit messages of other users and can pin messages; for channels only
can_pin_messagesBooleanOptional. True, if the user is allowed to pin messages; for groups and supergroups only
can_manage_topicsBooleanOptional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
can_manage_direct_messagesBooleanOptional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only
can_manage_tagsBooleanOptional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.
+

ChatMemberUpdated

+

This object represents changes in the status of a chat member.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
chatChatChat the user belongs to
fromUserPerformer of the action, which resulted in the change
dateIntegerDate the change was done in Unix time
old_chat_memberChatMemberPrevious information about the chat member
new_chat_memberChatMemberNew information about the chat member
invite_linkChatInviteLinkOptional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only
via_join_requestBooleanOptional. True, if the user joined the chat after sending a direct join request without using an invite link and being approved by an administrator
via_chat_folder_invite_linkBooleanOptional. True, if the user joined the chat via a chat folder invite link
+

ChatMember

+

This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:

+ +

ChatMemberOwner

+

Represents a chat member that owns the chat and has all administrator privileges.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
statusStringThe member's status in the chat, always “creator”
userUserInformation about the user
is_anonymousBooleanTrue, if the user's presence in the chat is hidden
custom_titleStringOptional. Custom title for this user
+

ChatMemberAdministrator

+

Represents a chat member that has some additional privileges.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
statusStringThe member's status in the chat, always “administrator”
userUserInformation about the user
can_be_editedBooleanTrue, if the bot is allowed to edit administrator privileges of that user
is_anonymousBooleanTrue, if the user's presence in the chat is hidden
can_manage_chatBooleanTrue, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.
can_delete_messagesBooleanTrue, if the administrator can delete messages of other users
can_manage_video_chatsBooleanTrue, if the administrator can manage video chats
can_restrict_membersBooleanTrue, if the administrator can restrict, ban or unban chat members, or access supergroup statistics
can_promote_membersBooleanTrue, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by the user)
can_change_infoBooleanTrue, if the user is allowed to change the chat title, photo and other settings
can_invite_usersBooleanTrue, if the user is allowed to invite new users to the chat
can_post_storiesBooleanTrue, if the administrator can post stories to the chat
can_edit_storiesBooleanTrue, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
can_delete_storiesBooleanTrue, if the administrator can delete stories posted by other users
can_post_messagesBooleanOptional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only
can_edit_messagesBooleanOptional. True, if the administrator can edit messages of other users and can pin messages; for channels only
can_pin_messagesBooleanOptional. True, if the user is allowed to pin messages; for groups and supergroups only
can_manage_topicsBooleanOptional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
can_manage_direct_messagesBooleanOptional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only
can_manage_tagsBooleanOptional. True, if the administrator can edit the tags of regular members; for groups and supergroups only. If omitted defaults to the value of can_pin_messages.
custom_titleStringOptional. Custom title for this user
+

ChatMemberMember

+

Represents a chat member that has no additional privileges or restrictions.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
statusStringThe member's status in the chat, always “member”
tagStringOptional. Tag of the member
userUserInformation about the user
until_dateIntegerOptional. Date when the user's subscription will expire; Unix time
+

ChatMemberRestricted

+

Represents a chat member that is under certain restrictions in the chat. Supergroups only.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
statusStringThe member's status in the chat, always “restricted”
tagStringOptional. Tag of the member
userUserInformation about the user
is_memberBooleanTrue, if the user is a member of the chat at the moment of the request
can_send_messagesBooleanTrue, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues
can_send_audiosBooleanTrue, if the user is allowed to send audios
can_send_documentsBooleanTrue, if the user is allowed to send documents
can_send_photosBooleanTrue, if the user is allowed to send photos
can_send_videosBooleanTrue, if the user is allowed to send videos
can_send_video_notesBooleanTrue, if the user is allowed to send video notes
can_send_voice_notesBooleanTrue, if the user is allowed to send voice notes
can_send_pollsBooleanTrue, if the user is allowed to send polls and checklists
can_send_other_messagesBooleanTrue, if the user is allowed to send animations, games, stickers and use inline bots
can_add_web_page_previewsBooleanTrue, if the user is allowed to add web page previews to their messages
can_react_to_messagesBooleanTrue, if the user is allowed to react to messages
can_edit_tagBooleanTrue, if the user is allowed to edit their own tag
can_change_infoBooleanTrue, if the user is allowed to change the chat title, photo and other settings
can_invite_usersBooleanTrue, if the user is allowed to invite new users to the chat
can_pin_messagesBooleanTrue, if the user is allowed to pin messages
can_manage_topicsBooleanTrue, if the user is allowed to create forum topics
until_dateIntegerDate when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever.
+

ChatMemberLeft

+

Represents a chat member that isn't currently a member of the chat, but may join it themselves.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
statusStringThe member's status in the chat, always “left”
userUserInformation about the user
+

ChatMemberBanned

+

Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
statusStringThe member's status in the chat, always “kicked”
userUserInformation about the user
until_dateIntegerDate when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever.
+

ChatJoinRequest

+

Represents a join request sent to a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
chatChatChat to which the request was sent
fromUserUser that sent the join request
user_chat_idIntegerIdentifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other administrator contacted the user.
dateIntegerDate the request was sent in Unix time
bioStringOptional. Bio of the user
invite_linkChatInviteLinkOptional. Chat invite link that was used by the user to send the join request
+

ChatPermissions

+

Describes actions that a non-administrator user is allowed to take in a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
can_send_messagesBooleanOptional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues
can_send_audiosBooleanOptional. True, if the user is allowed to send audios
can_send_documentsBooleanOptional. True, if the user is allowed to send documents
can_send_photosBooleanOptional. True, if the user is allowed to send photos
can_send_videosBooleanOptional. True, if the user is allowed to send videos
can_send_video_notesBooleanOptional. True, if the user is allowed to send video notes
can_send_voice_notesBooleanOptional. True, if the user is allowed to send voice notes
can_send_pollsBooleanOptional. True, if the user is allowed to send polls and checklists
can_send_other_messagesBooleanOptional. True, if the user is allowed to send animations, games, stickers and use inline bots
can_add_web_page_previewsBooleanOptional. True, if the user is allowed to add web page previews to their messages
can_react_to_messagesBooleanOptional. True, if the user is allowed to react to messages. If omitted, defaults to the value of can_send_messages.
can_edit_tagBooleanOptional. True, if the user is allowed to edit their own tag. If omitted, defaults to the value of can_pin_messages.
can_change_infoBooleanOptional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups.
can_invite_usersBooleanOptional. True, if the user is allowed to invite new users to the chat
can_pin_messagesBooleanOptional. True, if the user is allowed to pin messages. Ignored in public supergroups.
can_manage_topicsBooleanOptional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages.
+

Birthdate

+

Describes the birthdate of a user.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
dayIntegerDay of the user's birth; 1-31
monthIntegerMonth of the user's birth; 1-12
yearIntegerOptional. Year of the user's birth
+

BusinessIntro

+

Contains information about the start page settings of a Telegram Business account.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
titleStringOptional. Title text of the business intro
messageStringOptional. Message text of the business intro
stickerStickerOptional. Sticker of the business intro
+

BusinessLocation

+

Contains information about the location of a Telegram Business account.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
addressStringAddress of the business
locationLocationOptional. Location of the business
+

BusinessOpeningHoursInterval

+

Describes an interval of time during which a business is open.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
opening_minuteIntegerThe minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the business is open; 0 - 7 * 24 * 60
closing_minuteIntegerThe minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the business is open; 0 - 8 * 24 * 60
+

BusinessOpeningHours

+

Describes the opening hours of a business.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
time_zone_nameStringUnique name of the time zone for which the opening hours are defined
opening_hoursArray of BusinessOpeningHoursIntervalList of time intervals describing business opening hours
+

UserRating

+

This object describes the rating of a user based on their Telegram Star spendings.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
levelIntegerCurrent level of the user, indicating their reliability when purchasing digital goods and services. A higher level suggests a more trustworthy customer; a negative level is likely reason for concern.
ratingIntegerNumerical value of the user's rating; the higher the rating, the better
current_level_ratingIntegerThe rating value required to get the current level
next_level_ratingIntegerOptional. The rating value required to get to the next level; omitted if the maximum level was reached
+

StoryAreaPosition

+

Describes the position of a clickable area within a story.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
x_percentageFloatThe abscissa of the area's center, as a percentage of the media width
y_percentageFloatThe ordinate of the area's center, as a percentage of the media height
width_percentageFloatThe width of the area's rectangle, as a percentage of the media width
height_percentageFloatThe height of the area's rectangle, as a percentage of the media height
rotation_angleFloatThe clockwise rotation angle of the rectangle, in degrees; 0-360
corner_radius_percentageFloatThe radius of the rectangle corner rounding, as a percentage of the media width
+

LocationAddress

+

Describes the physical address of a location.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
country_codeStringThe two-letter ISO 3166-1 alpha-2 country code of the country where the location is located
stateStringOptional. State of the location
cityStringOptional. City of the location
streetStringOptional. Street address of the location
+

StoryAreaType

+

Describes the type of a clickable area on a story. Currently, it can be one of

+ +

StoryAreaTypeLocation

+

Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the area, always “location”
latitudeFloatLocation latitude in degrees
longitudeFloatLocation longitude in degrees
addressLocationAddressOptional. Address of the location
+

StoryAreaTypeSuggestedReaction

+

Describes a story area pointing to a suggested reaction. Currently, a story can have up to 5 suggested reaction areas.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the area, always “suggested_reaction”
reaction_typeReactionTypeType of the reaction
is_darkBooleanOptional. Pass True if the reaction area has a dark background
is_flippedBooleanOptional. Pass True if reaction area corner is flipped
+

StoryAreaTypeLink

+

Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the area, always “link”
urlStringHTTP or tg:// URL to be opened when the area is clicked
+

StoryAreaTypeWeather

+

Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the area, always “weather”
temperatureFloatTemperature, in degree Celsius
emojiStringEmoji representing the weather
background_colorIntegerA color of the area background in the ARGB format
+

StoryAreaTypeUniqueGift

+

Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the area, always “unique_gift”
nameStringUnique name of the gift
+

StoryArea

+

Describes a clickable area on a story media.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
positionStoryAreaPositionPosition of the area
typeStoryAreaTypeType of the area
+

ChatLocation

+

Represents a location to which a chat is connected.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
locationLocationThe location to which the supergroup is connected. Can't be a live location.
addressStringLocation address; 1-64 characters, as defined by the chat owner
+

ReactionType

+

This object describes the type of a reaction. Currently, it can be one of

+ +

ReactionTypeEmoji

+

The reaction is based on an emoji.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the reaction, always “emoji”
emojiStringReaction emoji. Currently, it can be one of "❤", "👍", "👎", "🔥", "🥰", "👏", "😁", "🤔", "🤯", "😱", "🤬", "😢", "🎉", "🤩", "🤮", "💩", "🙏", "👌", "🕊", "🤡", "🥱", "🥴", "😍", "🐳", "❤‍🔥", "🌚", "🌭", "💯", "🤣", "⚡", "🍌", "🏆", "💔", "🤨", "😐", "🍓", "🍾", "💋", "🖕", "😈", "😴", "😭", "🤓", "👻", "👨‍💻", "👀", "🎃", "🙈", "😇", "😨", "🤝", "✍", "🤗", "🫡", "🎅", "🎄", "☃", "💅", "🤪", "🗿", "🆒", "💘", "🙉", "🦄", "😘", "💊", "🙊", "😎", "👾", "🤷‍♂", "🤷", "🤷‍♀", "😡".
+

ReactionTypeCustomEmoji

+

The reaction is based on a custom emoji.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the reaction, always “custom_emoji”
custom_emoji_idStringCustom emoji identifier
+

ReactionTypePaid

+

The reaction is paid.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the reaction, always “paid”
+

ReactionCount

+

Represents a reaction added to a message along with the number of times it was added.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeReactionTypeType of the reaction
total_countIntegerNumber of times the reaction was added
+

MessageReactionUpdated

+

This object represents a change of a reaction on a message performed by a user.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
chatChatThe chat containing the message the user reacted to
message_idIntegerUnique identifier of the message inside the chat
userUserOptional. The user that changed the reaction, if the user isn't anonymous
actor_chatChatOptional. The chat on behalf of which the reaction was changed, if the user is anonymous
dateIntegerDate of the change in Unix time
old_reactionArray of ReactionTypePrevious list of reaction types that were set by the user
new_reactionArray of ReactionTypeNew list of reaction types that have been set by the user
+

MessageReactionCountUpdated

+

This object represents reaction changes on a message with anonymous reactions.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
chatChatThe chat containing the message
message_idIntegerUnique message identifier inside the chat
dateIntegerDate of the change in Unix time
reactionsArray of ReactionCountList of reactions that are present on the message
+

ForumTopic

+

This object represents a forum topic.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
message_thread_idIntegerUnique identifier of the forum topic
nameStringName of the topic
icon_colorIntegerColor of the topic icon in RGB format
icon_custom_emoji_idStringOptional. Unique identifier of the custom emoji shown as the topic icon
is_name_implicitTrueOptional. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot
+

GiftBackground

+

This object describes the background of a gift.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
center_colorIntegerCenter color of the background in RGB format
edge_colorIntegerEdge color of the background in RGB format
text_colorIntegerText color of the background in RGB format
+

Gift

+

This object represents a gift that can be sent by the bot.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idStringUnique identifier of the gift
stickerStickerThe sticker that represents the gift
star_countIntegerThe number of Telegram Stars that must be paid to send the sticker
upgrade_star_countIntegerOptional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one
is_premiumTrueOptional. True, if the gift can only be purchased by Telegram Premium subscribers
has_colorsTrueOptional. True, if the gift can be used (after being upgraded) to customize a user's appearance
total_countIntegerOptional. The total number of gifts of this type that can be sent by all users; for limited gifts only
remaining_countIntegerOptional. The number of remaining gifts of this type that can be sent by all users; for limited gifts only
personal_total_countIntegerOptional. The total number of gifts of this type that can be sent by the bot; for limited gifts only
personal_remaining_countIntegerOptional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only
backgroundGiftBackgroundOptional. Background of the gift
unique_gift_variant_countIntegerOptional. The total number of different unique gifts that can be obtained by upgrading the gift
publisher_chatChatOptional. Information about the chat that published the gift
+

Gifts

+

This object represent a list of gifts.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
giftsArray of GiftThe list of gifts
+

UniqueGiftModel

+

This object describes the model of a unique gift.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
nameStringName of the model
stickerStickerThe sticker that represents the unique gift
rarity_per_milleIntegerThe number of unique gifts that receive this model for every 1000 gift upgrades. Always 0 for crafted gifts.
rarityStringOptional. Rarity of the model if it is a crafted model. Currently, can be “uncommon”, “rare”, “epic”, or “legendary”.
+

UniqueGiftSymbol

+

This object describes the symbol shown on the pattern of a unique gift.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
nameStringName of the symbol
stickerStickerThe sticker that represents the unique gift
rarity_per_milleIntegerThe number of unique gifts that receive this model for every 1000 gifts upgraded
+

UniqueGiftBackdropColors

+

This object describes the colors of the backdrop of a unique gift.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
center_colorIntegerThe color in the center of the backdrop in RGB format
edge_colorIntegerThe color on the edges of the backdrop in RGB format
symbol_colorIntegerThe color to be applied to the symbol in RGB format
text_colorIntegerThe color for the text on the backdrop in RGB format
+

UniqueGiftBackdrop

+

This object describes the backdrop of a unique gift.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
nameStringName of the backdrop
colorsUniqueGiftBackdropColorsColors of the backdrop
rarity_per_milleIntegerThe number of unique gifts that receive this backdrop for every 1000 gifts upgraded
+

UniqueGiftColors

+

This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
model_custom_emoji_idStringCustom emoji identifier of the unique gift's model
symbol_custom_emoji_idStringCustom emoji identifier of the unique gift's symbol
light_theme_main_colorIntegerMain color used in light themes; RGB format
light_theme_other_colorsArray of IntegerList of 1-3 additional colors used in light themes; RGB format
dark_theme_main_colorIntegerMain color used in dark themes; RGB format
dark_theme_other_colorsArray of IntegerList of 1-3 additional colors used in dark themes; RGB format
+

UniqueGift

+

This object describes a unique gift that was upgraded from a regular gift.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
gift_idStringIdentifier of the regular gift from which the gift was upgraded
base_nameStringHuman-readable name of the regular gift from which this unique gift was upgraded
nameStringUnique name of the gift. This name can be used in https://t.me/nft/... links and story areas.
numberIntegerUnique number of the upgraded gift among gifts upgraded from the same regular gift
modelUniqueGiftModelModel of the gift
symbolUniqueGiftSymbolSymbol of the gift
backdropUniqueGiftBackdropBackdrop of the gift
is_premiumTrueOptional. True, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers
is_burnedTrueOptional. True, if the gift was used to craft another gift and isn't available anymore
is_from_blockchainTrueOptional. True, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram
colorsUniqueGiftColorsOptional. The color scheme that can be used by the gift's owner for the chat's name, replies to messages and link previews; for business account gifts and gifts that are currently on sale only
publisher_chatChatOptional. Information about the chat that published the gift
+

GiftInfo

+

Describes a service message about a regular gift that was sent or received.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
giftGiftInformation about the gift
owned_gift_idStringOptional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts
convert_star_countIntegerOptional. Number of Telegram Stars that can be claimed by the receiver by converting the gift; omitted if conversion to Telegram Stars is impossible
prepaid_upgrade_star_countIntegerOptional. Number of Telegram Stars that were prepaid for the ability to upgrade the gift
is_upgrade_separateTrueOptional. True, if the gift's upgrade was purchased after the gift was sent
can_be_upgradedTrueOptional. True, if the gift can be upgraded to a unique gift
textStringOptional. Text of the message that was added to the gift
entitiesArray of MessageEntityOptional. Special entities that appear in the text
is_privateTrueOptional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them
unique_gift_numberIntegerOptional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift.
+

UniqueGiftInfo

+

Describes a service message about a unique gift that was sent or received.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
giftUniqueGiftInformation about the gift
originStringOrigin of the gift. Currently, either “upgrade” for gifts upgraded from regular gifts, “transfer” for gifts transferred from other users or channels, “resale” for gifts bought from other users, “gifted_upgrade” for upgrades purchased after the gift was sent, or “offer” for gifts bought or sold through gift purchase offers.
last_resale_currencyStringOptional. For gifts bought from other users, the currency in which the payment for the gift was done. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins.
last_resale_amountIntegerOptional. For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins
owned_gift_idStringOptional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts
transfer_star_countIntegerOptional. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift
next_transfer_dateIntegerOptional. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now.
+

OwnedGift

+

This object describes a gift received and owned by a user or a chat. Currently, it can be one of

+ +

OwnedGiftRegular

+

Describes a regular gift owned by a user or a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the gift, always “regular”
giftGiftInformation about the regular gift
owned_gift_idStringOptional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only
sender_userUserOptional. Sender of the gift if it is a known user
send_dateIntegerDate the gift was sent in Unix time
textStringOptional. Text of the message that was added to the gift
entitiesArray of MessageEntityOptional. Special entities that appear in the text
is_privateTrueOptional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them
is_savedTrueOptional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only
can_be_upgradedTrueOptional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only
was_refundedTrueOptional. True, if the gift was refunded and isn't available anymore
convert_star_countIntegerOptional. Number of Telegram Stars that can be claimed by the receiver instead of the gift; omitted if the gift cannot be converted to Telegram Stars; for gifts received on behalf of business accounts only
prepaid_upgrade_star_countIntegerOptional. Number of Telegram Stars that were paid for the ability to upgrade the gift
is_upgrade_separateTrueOptional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only
unique_gift_numberIntegerOptional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift.
+

OwnedGiftUnique

+

Describes a unique gift received and owned by a user or a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the gift, always “unique”
giftUniqueGiftInformation about the unique gift
owned_gift_idStringOptional. Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only
sender_userUserOptional. Sender of the gift if it is a known user
send_dateIntegerDate the gift was sent in Unix time
is_savedTrueOptional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only
can_be_transferredTrueOptional. True, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only
transfer_star_countIntegerOptional. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift
next_transfer_dateIntegerOptional. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now.
+

OwnedGifts

+

Contains the list of gifts received and owned by a user or a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
total_countIntegerThe total number of gifts owned by the user or the chat
giftsArray of OwnedGiftThe list of gifts
next_offsetStringOptional. Offset for the next request. If empty, then there are no more results.
+

BotAccessSettings

+

This object describes the access settings of a bot.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
is_access_restrictedBooleanTrue, if only selected users can access the bot. The bot's owner can always access it.
added_usersArray of UserOptional. The list of other users who have access to the bot if the access is restricted
+

AcceptedGiftTypes

+

This object describes the types of gifts that can be gifted to a user or a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
unlimited_giftsBooleanTrue, if unlimited regular gifts are accepted
limited_giftsBooleanTrue, if limited regular gifts are accepted
unique_giftsBooleanTrue, if unique gifts or gifts that can be upgraded to unique for free are accepted
premium_subscriptionBooleanTrue, if a Telegram Premium subscription is accepted
gifts_from_channelsBooleanTrue, if transfers of unique gifts from channels are accepted
+

StarAmount

+

Describes an amount of Telegram Stars.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
amountIntegerInteger amount of Telegram Stars, rounded to 0; can be negative
nanostar_amountIntegerOptional. The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if amount is non-positive
+

BotCommand

+

This object represents a bot command.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
commandStringText of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.
descriptionStringDescription of the command; 1-256 characters
+

BotCommandScope

+

This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:

+ +

Determining list of commands

+

The following algorithm is used to determine the list of commands for a particular user viewing the bot menu. The first list of commands which is set is returned:

+

Commands in the chat with the bot

+
    +
  • botCommandScopeChat + language_code
    • +
  • botCommandScopeChat
    • +
  • botCommandScopeAllPrivateChats + language_code
    • +
  • botCommandScopeAllPrivateChats
    • +
  • botCommandScopeDefault + language_code
    • +
  • botCommandScopeDefault
    • +
+

Commands in group and supergroup chats

+
    +
  • botCommandScopeChatMember + language_code
    • +
  • botCommandScopeChatMember
    • +
  • botCommandScopeChatAdministrators + language_code (administrators only)
    • +
  • botCommandScopeChatAdministrators (administrators only)
    • +
  • botCommandScopeChat + language_code
    • +
  • botCommandScopeChat
    • +
  • botCommandScopeAllChatAdministrators + language_code (administrators only)
    • +
  • botCommandScopeAllChatAdministrators (administrators only)
    • +
  • botCommandScopeAllGroupChats + language_code
    • +
  • botCommandScopeAllGroupChats
    • +
  • botCommandScopeDefault + language_code
    • +
  • botCommandScopeDefault
    • +
+

BotCommandScopeDefault

+

Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringScope type, must be default
+

BotCommandScopeAllPrivateChats

+

Represents the scope of bot commands, covering all private chats.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringScope type, must be all_private_chats
+

BotCommandScopeAllGroupChats

+

Represents the scope of bot commands, covering all group and supergroup chats.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringScope type, must be all_group_chats
+

BotCommandScopeAllChatAdministrators

+

Represents the scope of bot commands, covering all group and supergroup chat administrators.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringScope type, must be all_chat_administrators
+

BotCommandScopeChat

+

Represents the scope of bot commands, covering a specific chat.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringScope type, must be chat
chat_idInteger or StringUnique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported.
+

BotCommandScopeChatAdministrators

+

Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringScope type, must be chat_administrators
chat_idInteger or StringUnique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported.
+

BotCommandScopeChatMember

+

Represents the scope of bot commands, covering a specific member of a group or supergroup chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringScope type, must be chat_member
chat_idInteger or StringUnique identifier for the target chat or username of the target supergroup in the format @username. Channel direct messages chats and channel chats aren't supported.
user_idIntegerUnique identifier of the target user
+

BotName

+

This object represents the bot's name.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
nameStringThe bot's name
+

BotDescription

+

This object represents the bot's description.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
descriptionStringThe bot's description
+

BotShortDescription

+

This object represents the bot's short description.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
short_descriptionStringThe bot's short description
+

MenuButton

+

This object describes the bot's menu button in a private chat. It should be one of

+ +

If a menu button other than MenuButtonDefault is set for a private chat, then it is applied in the chat. Otherwise the default menu button is applied. By default, the menu button opens the list of bot commands.

+

MenuButtonCommands

+

Represents a menu button, which opens the bot's list of commands.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the button, must be commands
+

MenuButtonWebApp

+

Represents a menu button, which launches a Web App.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the button, must be web_app
textStringText on the button
web_appWebAppInfoDescription of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Alternatively, a t.me link to a Web App of the bot can be specified in the object instead of the Web App's URL, in which case the Web App will be opened as if the user pressed the link.
+

MenuButtonDefault

+

Describes that no specific value for the menu button was set.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the button, must be default
+

ChatBoostSource

+

This object describes the source of a chat boost. It can be one of

+ +

ChatBoostSourcePremium

+

The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringSource of the boost, always “premium”
userUserUser that boosted the chat
+

ChatBoostSourceGiftCode

+

The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringSource of the boost, always “gift_code”
userUserUser for which the gift code was created
+

ChatBoostSourceGiveaway

+

The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringSource of the boost, always “giveaway”
giveaway_message_idIntegerIdentifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet.
userUserOptional. User that won the prize in the giveaway if any; for Telegram Premium giveaways only
prize_star_countIntegerOptional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
is_unclaimedTrueOptional. True, if the giveaway was completed, but there was no user to win the prize
+

ChatBoost

+

This object contains information about a chat boost.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
boost_idStringUnique identifier of the boost
add_dateIntegerPoint in time (Unix timestamp) when the chat was boosted
expiration_dateIntegerPoint in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged
sourceChatBoostSourceSource of the added boost
+

ChatBoostUpdated

+

This object represents a boost added to a chat or changed.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
chatChatChat which was boosted
boostChatBoostInformation about the chat boost
+

ChatBoostRemoved

+

This object represents a boost removed from a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
chatChatChat which was boosted
boost_idStringUnique identifier of the boost
remove_dateIntegerPoint in time (Unix timestamp) when the boost was removed
sourceChatBoostSourceSource of the removed boost
+

ChatOwnerLeft

+

Describes a service message about the chat owner leaving the chat.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
new_ownerUserOptional. The user who will become the new owner of the chat if the previous owner does not return to the chat
+

ChatOwnerChanged

+

Describes a service message about an ownership change in the chat.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
new_ownerUserThe new owner of the chat
+

UserChatBoosts

+

This object represents a list of boosts added to a chat by a user.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
boostsArray of ChatBoostThe list of boosts added to the chat by the user
+

BusinessBotRights

+

Represents the rights of a business bot.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
can_replyTrueOptional. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours
can_read_messagesTrueOptional. True, if the bot can mark incoming private messages as read
can_delete_sent_messagesTrueOptional. True, if the bot can delete messages sent by the bot
can_delete_all_messagesTrueOptional. True, if the bot can delete all private messages in managed chats
can_edit_nameTrueOptional. True, if the bot can edit the first and last name of the business account
can_edit_bioTrueOptional. True, if the bot can edit the bio of the business account
can_edit_profile_photoTrueOptional. True, if the bot can edit the profile photo of the business account
can_edit_usernameTrueOptional. True, if the bot can edit the username of the business account
can_change_gift_settingsTrueOptional. True, if the bot can change the privacy settings pertaining to gifts for the business account
can_view_gifts_and_starsTrueOptional. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account
can_convert_gifts_to_starsTrueOptional. True, if the bot can convert regular gifts owned by the business account to Telegram Stars
can_transfer_and_upgrade_giftsTrueOptional. True, if the bot can transfer and upgrade gifts owned by the business account
can_transfer_starsTrueOptional. True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts
can_manage_storiesTrueOptional. True, if the bot can post, edit and delete stories on behalf of the business account
+

BusinessConnection

+

Describes the connection of the bot with a business account.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idStringUnique identifier of the business connection
userUserBusiness account user that created the business connection
user_chat_idIntegerIdentifier of a private chat with the user who created the business connection. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
dateIntegerDate the connection was established in Unix time
rightsBusinessBotRightsOptional. Rights of the business bot
is_enabledBooleanTrue, if the connection is active
+

BusinessMessagesDeleted

+

This object is received when messages are deleted from a connected business account.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
business_connection_idStringUnique identifier of the business connection
chatChatInformation about a chat in the business account. The bot may not have access to the chat or the corresponding user.
message_idsArray of IntegerThe list of identifiers of deleted messages in the chat of the business account
+

SentWebAppMessage

+

Describes an inline message sent by a Web App on behalf of a user.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
inline_message_idStringOptional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message.
+

SentGuestMessage

+

Describes an inline message sent by a guest bot.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
inline_message_idStringIdentifier of the sent inline message
+

PreparedInlineMessage

+

Describes an inline message to be sent by a user of a Mini App.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idStringUnique identifier of the prepared message
expiration_dateIntegerExpiration date of the prepared message, in Unix time. Expired prepared messages can no longer be used.
+

PreparedKeyboardButton

+

Describes a keyboard button to be used by a user of a Mini App.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
idStringUnique identifier of the keyboard button
+

ResponseParameters

+

Describes why a request was unsuccessful.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
migrate_to_chat_idIntegerOptional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
retry_afterIntegerOptional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated
+

InputMedia

+

This object represents the content of a media message to be sent. It should be one of

+ +

InputMediaAnimation

+

Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be animation
mediaStringFile to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
thumbnailStringOptional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
captionStringOptional. Caption of the animation to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the animation caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
widthIntegerOptional. Animation width
heightIntegerOptional. Animation height
durationIntegerOptional. Animation duration in seconds
has_spoilerBooleanOptional. Pass True if the animation needs to be covered with a spoiler animation
+

InputMediaAudio

+

Represents an audio file to be treated as music to be sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be audio
mediaStringFile to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
thumbnailStringOptional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
captionStringOptional. Caption of the audio to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the audio caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
durationIntegerOptional. Duration of the audio in seconds
performerStringOptional. Performer of the audio
titleStringOptional. Title of the audio
+

InputMediaDocument

+

Represents a general file to be sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be document
mediaStringFile to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
thumbnailStringOptional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
captionStringOptional. Caption of the document to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the document caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
disable_content_type_detectionBooleanOptional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.
+

InputMediaLivePhoto

+

Represents a live photo to be sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be live_photo
mediaStringVideo of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
photoStringThe static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
captionStringOptional. Caption of the live photo to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the live photo caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
has_spoilerBooleanOptional. Pass True if the live photo needs to be covered with a spoiler animation
+

InputMediaLocation

+

Represents a location to be sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be location
latitudeFloatLatitude of the location
longitudeFloatLongitude of the location
horizontal_accuracyFloatOptional. The radius of uncertainty for the location, measured in meters; 0-1500
+

InputMediaPhoto

+

Represents a photo to be sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be photo
mediaStringFile to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
captionStringOptional. Caption of the photo to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the photo caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
has_spoilerBooleanOptional. Pass True if the photo needs to be covered with a spoiler animation
+

InputMediaSticker

+

Represents a sticker file to be sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be sticker
mediaStringFile to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a .WEBP sticker from the Internet, or pass “attach://<file_attach_name>” to upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data under <file_attach_name> name. More information on Sending Files »
emojiStringOptional. Emoji associated with the sticker; only for just uploaded stickers
+

InputMediaVenue

+

Represents a venue to be sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be venue
latitudeFloatLatitude of the location
longitudeFloatLongitude of the location
titleStringName of the venue
addressStringAddress of the venue
foursquare_idStringOptional. Foursquare identifier of the venue
foursquare_typeStringOptional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
google_place_idStringOptional. Google Places identifier of the venue
google_place_typeStringOptional. Google Places type of the venue. (See supported types.)
+

InputMediaVideo

+

Represents a video to be sent.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be video
mediaStringFile to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
thumbnailStringOptional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
coverStringOptional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
start_timestampIntegerOptional. Start timestamp for the video in the message
captionStringOptional. Caption of the video to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the video caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
widthIntegerOptional. Video width
heightIntegerOptional. Video height
durationIntegerOptional. Video duration in seconds
supports_streamingBooleanOptional. Pass True if the uploaded video is suitable for streaming
has_spoilerBooleanOptional. Pass True if the video needs to be covered with a spoiler animation
+

InputFile

+

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.

+

InputPaidMedia

+

This object describes the paid media to be sent. Currently, it can be one of

+ +

InputPaidMediaLivePhoto

+

The paid media to send is a live photo.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the media, must be live_photo
mediaStringVideo of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
photoStringThe static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
+

InputPaidMediaPhoto

+

The paid media to send is a photo.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the media, must be photo
mediaStringFile to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
+

InputPaidMediaVideo

+

The paid media to send is a video.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the media, must be video
mediaStringFile to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
thumbnailStringOptional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
coverStringOptional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
start_timestampIntegerOptional. Start timestamp for the video in the message
widthIntegerOptional. Video width
heightIntegerOptional. Video height
durationIntegerOptional. Video duration in seconds
supports_streamingBooleanOptional. Pass True if the uploaded video is suitable for streaming
+

InputProfilePhoto

+

This object describes a profile photo to set. Currently, it can be one of

+ +

InputProfilePhotoStatic

+

A static profile photo in the .JPG format.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the profile photo, must be static
photoStringThe static profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
+

InputProfilePhotoAnimated

+

An animated profile photo in the MPEG4 format.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the profile photo, must be animated
animationStringThe animated profile photo. Profile photos can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
main_frame_timestampFloatOptional. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0.
+

InputStoryContent

+

This object describes the content of a story to post. Currently, it can be one of

+ +

InputStoryContentPhoto

+

Describes a photo to post as a story.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the content, must be photo
photoStringThe photo to post as a story. The photo must be of the size 1080x1920 and must not exceed 10 MB. The photo can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the photo was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
+

InputStoryContentVideo

+

Describes a video to post as a story.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the content, must be video
videoStringThe video to post as a story. The video must be of the size 720x1280, streamable, encoded with H.265 codec, with key frames added each second in the MPEG4 format, and must not exceed 30 MB. The video can't be reused and can only be uploaded as a new file, so you can pass “attach://<file_attach_name>” if the video was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
durationFloatOptional. Precise duration of the video in seconds; 0-60
cover_frame_timestampFloatOptional. Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0.
is_animationBooleanOptional. Pass True if the video has no sound
+

Sending files

+

There are three ways to send files (photos, stickers, audio, media, etc.):

+
    +
  1. If the file is already stored somewhere on the Telegram servers, you don't need to reupload it: each file object has a file_id field, simply pass this file_id as a parameter instead of uploading. There are no limits for files sent this way.
    2. +
  2. Provide Telegram with an HTTP URL for the file to be sent. Telegram will download and send the file. 5 MB max size for photos and 20 MB max for other types of content.
    3. +
  3. Post the file using multipart/form-data in the usual way that files are uploaded via the browser. 10 MB max size for photos, 50 MB for other files.
    4. +
+

Sending by file_id

+
    +
  • It is not possible to change the file type when resending by file_id. I.e. a video can't be sent as a photo, a photo can't be sent as a document, etc.
    • +
  • It is not possible to resend thumbnails.
    • +
  • Resending a photo by file_id will send all of its sizes.
    • +
  • file_id is unique for each individual bot and can't be transferred from one bot to another.
    • +
  • file_id uniquely identifies a file, but a file can have different valid file_ids even for the same bot.
    • +
+

Sending by URL

+
    +
  • When sending by URL the target file must have the correct MIME type (e.g., audio/mpeg for sendAudio, etc.).
    • +
  • In sendDocument, sending by URL will currently only work for .PDF and .ZIP files.
    • +
  • To use sendVoice, the file must have the type audio/ogg and be no more than 1MB in size. 1-20MB voice notes will be sent as files.
    • +
  • Other configurations may work but we can't guarantee that they will.
    • +
+

Accent colors

+

Colors with identifiers 0 (red), 1 (orange), 2 (purple/violet), 3 (green), 4 (cyan), 5 (blue), 6 (pink) can be customized by app themes. Additionally, the following colors in RGB format are currently in use.

+

+ + + + + + + + + + + + + + + + + + + +
Color identifierLight colorsDark colors
7E15052 F9AE63FF9380 992F37
8E0802B FAC534ECB04E C35714
9A05FF3 F48FFFC697FF 5E31C8
1027A910 A7DC57A7EB6E 167E2D
1127ACCE 82E8D640D8D0 045C7F
123391D4 7DD3F052BFFF 0B5494
13DD4371 FFBE9FFF86A6 8E366E
14247BED F04856 FFFFFF3FA2FE E5424F FFFFFF
15D67722 1EA011 FFFFFFFF905E 32A527 FFFFFF
16179E42 E84A3F FFFFFF66D364 D5444F FFFFFF
172894AF 6FC456 FFFFFF22BCE2 3DA240 FFFFFF
180C9AB3 FFAD95 FFE6B522BCE2 FF9778 FFDA6B
197757D6 F79610 FFDE8E9791FF F2731D FFDB59
201585CF F2AB1D FFFFFF3DA6EB EEA51D FFFFFF

+

Profile accent colors

+

Currently, the following colors in RGB format are in use for profile backgrounds.

+

+ + + + + + + + + + + + + + + + + + + + + +
Color identifierLight colorsDark colors
0BA56509C4540
1C27C3E945E2C
2956AC8715099
349A35533713B
43E97AD387E87
55A8FBB477194
6B85378944763
77F8B95435261
8C9565D D97C57994343 AC583E
9CF7244 CC94338F552F A17232
109662D4 B966B6634691 9250A2
113D9755 89A650296A43 5F8F44
123D95BA 50AD98306C7C 3E987E
13538BC2 4DA8BD38618C 458BA1
14B04F74 D1666D884160 A65259
15637482 7B8A9753606E 384654

+

Inline mode objects

+

Objects and methods used in the inline mode are described in the Inline mode section.

+

Available methods

+
+

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.

+
+

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.

+

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

+

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

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
textStringYesText of the message to be sent, 1-4096 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the message text. See formatting options for more details.
entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
link_preview_optionsLinkPreviewOptionsOptionalLink preview generation options for the message
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

Formatting options

+

The Bot API supports basic formatting for messages. You can use bold, italic, underlined, strikethrough, spoiler text, block quotations as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can specify text entities directly, or use 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).

+

Message entities can be nested, providing following restrictions are met:
- If two entities have common characters, then one of them is fully contained inside another.
- bold, italic, underline, strikethrough, and spoiler entities can contain and can be part of any other entities, except pre and code.
- blockquote and expandable_blockquote entities can't be nested.
- All other entities can't contain each other.

+

Links tg://user?id=<user_id> can be used to mention a user by their identifier without using a username. Please note:

+
    +
  • These links will work only if they are used inside an inline link or in an inline keyboard button. For example, they will not work, when used in a message text.
    • +
  • Unless the user is a member of the chat where they were mentioned, these mentions are only guaranteed to work if the user has contacted the bot in private in the past or has sent a callback query to the bot via an inline button and doesn't have Forwarded Messages privacy enabled for the bot.
    • +
+

You can find the list of programming and markup languages for which syntax highlighting is supported at libprisma#supported-languages.

+
Date-time entity formatting
+

Date-time entity formatting is specified by a format string, which must adhere to the following regular expression: r|w?[dD]?[tT]?.

+

If the format string is empty, the underlying text is displayed as-is; however, the user can still receive the underlying date in their local format. When populated, the format string determines the output based on the presence of the following control characters:

+
    +
  • r: Displays the time relative to the current time. Cannot be combined with any other control characters.
    • +
  • w: Displays the day of the week in the user's localized language.
    • +
  • d: Displays the date in short form (e.g., “17.03.22”).
    • +
  • D: Displays the date in long form (e.g., “March 17, 2022”).
    • +
  • t: Displays the time in short form (e.g., “22:45”).
    • +
  • T: Displays the time in long form (e.g., “22:45:00”).
    • +
+
MarkdownV2 style
+

To use this mode, pass MarkdownV2 in the parse_mode field. Use the following syntax in your message:

+
*bold \*text*
+_italic \*text_
+__underline__
+~strikethrough~
+||spoiler||
+*bold _italic bold ~italic bold strikethrough ||italic bold strikethrough spoiler||~ __underline italic bold___ bold*
+[inline URL](http://www.example.com/)
+[inline mention of a user](tg://user?id=123456789)
+![👍](tg://emoji?id=5368324170671202286)
+![22:45 tomorrow](tg://time?unix=1647531900&format=wDT)
+![22:45 tomorrow](tg://time?unix=1647531900&format=t)
+![22:45 tomorrow](tg://time?unix=1647531900&format=r)
+![22:45 tomorrow](tg://time?unix=1647531900)
+`inline fixed-width code`
+```
+pre-formatted fixed-width code block
+```
+```python
+pre-formatted fixed-width code block written in the Python programming language
+```
+>Block quotation started
+>Block quotation continued
+>Block quotation continued
+>Block quotation continued
+>The last line of the block quotation
+**>The expandable block quotation started right after the previous block quotation
+>It is separated from the previous block quotation by an empty bold entity
+>Expandable block quotation continued
+>Hidden by default part of the expandable block quotation started
+>Expandable block quotation continued
+>The last line of the expandable block quotation with the expandability mark||
+

Please note:

+
    +
  • Any character with code between 1 and 126 inclusively can be escaped anywhere with a preceding '\' character, in which case it is treated as an ordinary character and not a part of the markup. This implies that '\' character usually must be escaped with a preceding '\' character.
    • +
  • Inside pre and code entities, all '`' and '\' characters must be escaped with a preceding '\' character.
    • +
  • Inside the (...) part of the inline link and custom emoji definition, all ')' and '\' must be escaped with a preceding '\' character.
    • +
  • In all other places characters '_', '*', '[', ']', '(', ')', '~', '`', '>', '#', '+', '-', '=', '|', '{', '}', '.', '!' must be escaped with the preceding character '\'.
    • +
  • In case of ambiguity between italic and underline entities __ is always greedily treated from left to right as beginning or end of an underline entity, so instead of ___italic underline___ use ___italic underline_**__, adding an empty bold entity as a separator.
    • +
  • A valid emoji must be provided as an alternative value for the custom emoji. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.
    • +
  • Custom emoji entities can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
    • +
  • See date-time entity formatting for more details about supported date-time formats.
    • +
+
HTML style
+

To use this mode, pass HTML in the parse_mode field. The following tags are currently supported:

+
<b>bold</b>, <strong>bold</strong>
+<i>italic</i>, <em>italic</em>
+<u>underline</u>, <ins>underline</ins>
+<s>strikethrough</s>, <strike>strikethrough</strike>, <del>strikethrough</del>
+<span class="tg-spoiler">spoiler</span>, <tg-spoiler>spoiler</tg-spoiler>
+<b>bold <i>italic bold <s>italic bold strikethrough <span class="tg-spoiler">italic bold strikethrough spoiler</span></s> <u>underline italic bold</u></i> bold</b>
+<a href="http://www.example.com/">inline URL</a>
+<a href="tg://user?id=123456789">inline mention of a user</a>
+<tg-emoji emoji-id="5368324170671202286">👍</tg-emoji>
+<tg-time unix="1647531900" format="wDT">22:45 tomorrow</tg-time>
+<tg-time unix="1647531900" format="t">22:45 tomorrow</tg-time>
+<tg-time unix="1647531900" format="r">22:45 tomorrow</tg-time>
+<tg-time unix="1647531900">22:45 tomorrow</tg-time>
+<code>inline fixed-width code</code>
+<pre>pre-formatted fixed-width code block</pre>
+<pre><code class="language-python">pre-formatted fixed-width code block written in the Python programming language</code></pre>
+<blockquote>Block quotation started\nBlock quotation continued\nThe last line of the block quotation</blockquote>
+<blockquote expandable>Expandable block quotation started\nExpandable block quotation continued\nExpandable block quotation continued\nHidden by default part of the block quotation started\nExpandable block quotation continued\nThe last line of the block quotation</blockquote>
+

Please note:

+
    +
  • Only the tags mentioned above are currently supported.
    • +
  • All <, > and & symbols that are not a part of a tag or an HTML entity must be replaced with the corresponding HTML entities (< with &lt;, > with &gt; and & with &amp;).
    • +
  • All numerical HTML entities are supported.
    • +
  • The API currently supports only the following named HTML entities: &lt;, &gt;, &amp; and &quot;.
    • +
  • Use nested pre and code tags, to define programming language for pre entity.
    • +
  • Programming language can't be specified for standalone code tags.
    • +
  • A valid emoji must be used as the content of the tg-emoji tag. The emoji will be shown instead of the custom emoji in places where a custom emoji cannot be displayed (e.g., system notifications) or if the message is forwarded by a non-premium user. It is recommended to use the emoji from the emoji field of the custom emoji sticker.
    • +
  • Custom emoji entities can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
    • +
  • See date-time entity formatting for more details about supported date-time formats.
    • +
+
Markdown style
+

This is a legacy mode, retained for backward compatibility. To use this mode, pass Markdown in the parse_mode field. Use the following syntax in your message:

+
*bold text*
+_italic text_
+[inline URL](http://www.example.com/)
+[inline mention of a user](tg://user?id=123456789)
+`inline fixed-width code`
+```
+pre-formatted fixed-width code block
+```
+```python
+pre-formatted fixed-width code block written in the Python programming language
+```
+

Please note:

+
    +
  • Entities must not be nested, use parse mode MarkdownV2 instead.
    • +
  • There is no way to specify “underline”, “strikethrough”, “spoiler”, “blockquote”, “expandable_blockquote”, “custom_emoji”, and “date_time” entities, use parse mode MarkdownV2 instead.
    • +
  • To escape characters '_', '*', '`', '[' outside of an entity, prepend the character '\' before them.
    • +
  • Escaping inside entities is not allowed, so entity must be closed first and reopened again: use _snake_\__case_ for italic snake_case and *2*\**2=4* for bold 2*2=4.
    • +
+

Paid Broadcasts

+

By default, all bots are able to broadcast up to 30 messages per second to their users. Developers can increase this limit by enabling Paid Broadcasts in @BotFather - allowing their bot to broadcast up to 1000 messages per second.

+

Each message broadcasted over the free amount of 30 messages per second incurs a cost of 0.1 Stars per message, paid with Telegram Stars from the bot's balance. In order to use this feature, a bot must have at least 10,000 Stars on its balance.

+
+

Bots with increased limits are only charged for messages that are broadcasted successfully.

+
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat
from_chat_idInteger or StringYesUnique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username)
video_start_timestampIntegerOptionalNew start timestamp for the forwarded video in the message
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the forwarded message from forwarding and saving
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; only available when forwarding to private chats
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only
message_idIntegerYesMessage identifier in the chat specified in from_chat_id
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat
from_chat_idInteger or StringYesUnique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username)
message_idsArray of IntegerYesA JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.
disable_notificationBooleanOptionalSends the messages silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the forwarded messages from forwarding and saving
+

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_id 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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
from_chat_idInteger or StringYesUnique identifier for the chat where the original message was sent (or username of the target bot, supergroup or channel in the format @username)
message_idIntegerYesMessage identifier in the chat specified in from_chat_id
video_start_timestampIntegerOptionalNew start timestamp for the copied video in the message
captionStringOptionalNew caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept.
parse_modeStringOptionalMode for parsing entities in the new caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptionalPass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified.
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; only available when copying to private chats
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

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_id 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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat
from_chat_idInteger or StringYesUnique identifier for the chat where the original messages were sent (or username of the target bot, supergroup or channel in the format @username)
message_idsArray of IntegerYesA JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.
disable_notificationBooleanOptionalSends the messages silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent messages from forwarding and saving
remove_captionBooleanOptionalPass True to copy the messages without their captions
+

sendPhoto

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
photoInputFile or StringYesPhoto to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »
captionStringOptionalPhoto caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the photo caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptionalPass True, if the caption must be shown above the message media
has_spoilerBooleanOptionalPass True if the photo needs to be covered with a spoiler animation
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

sendLivePhoto

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel (in the format @channelusername)
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
live_photoInputFile or StringYesLive photo video to send. The video must be no longer than 10 seconds and must not exceed 10 MB in size. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
photoInputFile or StringYesThe static photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending live photos by a URL is currently unsupported.
captionStringOptionalVideo caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the video caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptionalPass True, if the caption must be shown above the message media
has_spoilerBooleanOptionalPass True if the video needs to be covered with a spoiler animation
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

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.

+

For sending voice messages, use the sendVoice method instead.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
audioInputFile or StringYesAudio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »
captionStringOptionalAudio caption, 0-1024 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the audio caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
durationIntegerOptionalDuration of the audio in seconds
performerStringOptionalPerformer
titleStringOptionalTrack name
thumbnailInputFile or StringOptionalThumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
documentInputFile or StringYesFile to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »
thumbnailInputFile or StringOptionalThumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
captionStringOptionalDocument caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the document caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
disable_content_type_detectionBooleanOptionalDisables automatic server-side content type detection for files uploaded using multipart/form-data
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
videoInputFile or StringYesVideo to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files »
durationIntegerOptionalDuration of sent video in seconds
widthIntegerOptionalVideo width
heightIntegerOptionalVideo height
thumbnailInputFile or StringOptionalThumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
coverInputFile or StringOptionalCover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
start_timestampIntegerOptionalStart timestamp for the video in the message
captionStringOptionalVideo caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the video caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptionalPass True, if the caption must be shown above the message media
has_spoilerBooleanOptionalPass True if the video needs to be covered with a spoiler animation
supports_streamingBooleanOptionalPass True if the uploaded video is suitable for streaming
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
animationInputFile or StringYesAnimation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files »
durationIntegerOptionalDuration of sent animation in seconds
widthIntegerOptionalAnimation width
heightIntegerOptionalAnimation height
thumbnailInputFile or StringOptionalThumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
captionStringOptionalAnimation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the animation caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptionalPass True, if the caption must be shown above the message media
has_spoilerBooleanOptionalPass True if the animation needs to be covered with a spoiler animation
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
voiceInputFile or StringYesAudio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »
captionStringOptionalVoice message caption, 0-1024 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the voice message caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
durationIntegerOptionalDuration of the voice message in seconds
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

sendVideoNote

+

As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
video_noteInputFile or StringYesVideo note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported.
durationIntegerOptionalDuration of sent video in seconds
lengthIntegerOptionalVideo width and height, i.e. diameter of the video message
thumbnailInputFile or StringOptionalThumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

sendPaidMedia

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
star_countIntegerYesThe number of Telegram Stars that must be paid to buy access to the media; 1-25000
mediaArray of InputPaidMediaYesA JSON-serialized array describing the media to be sent; up to 10 items
payloadStringOptionalBot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.
captionStringOptionalMedia caption, 0-1024 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the media caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptionalPass True, if the caption must be shown above the message media
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat
mediaArray of InputMediaAudio, InputMediaDocument, InputMediaLivePhoto, InputMediaPhoto and InputMediaVideoYesA JSON-serialized array describing messages to be sent, must include 2-10 items
disable_notificationBooleanOptionalSends messages silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent messages from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
reply_parametersReplyParametersOptionalDescription of the message to reply to
+

sendLocation

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
latitudeFloatYesLatitude of the location
longitudeFloatYesLongitude of the location
horizontal_accuracyFloatOptionalThe radius of uncertainty for the location, measured in meters; 0-1500
live_periodIntegerOptionalPeriod in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely
headingIntegerOptionalFor live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
proximity_alert_radiusIntegerOptionalFor live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

sendVenue

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
latitudeFloatYesLatitude of the venue
longitudeFloatYesLongitude of the venue
titleStringYesName of the venue
addressStringYesAddress of the venue
foursquare_idStringOptionalFoursquare identifier of the venue
foursquare_typeStringOptionalFoursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
google_place_idStringOptionalGoogle Places identifier of the venue
google_place_typeStringOptionalGoogle Places type of the venue. (See supported types.)
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

sendContact

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
phone_numberStringYesContact's phone number
first_nameStringYesContact's first name
last_nameStringOptionalContact's last name
vcardStringOptionalAdditional data about the contact in the form of a vCard, 0-2048 bytes
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

sendPoll

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Polls can't be sent to channel direct messages chats.
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
questionStringYesPoll question, 1-300 characters
question_parse_modeStringOptionalMode for parsing entities in the question. See formatting options for more details. Currently, only custom emoji entities are allowed.
question_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the poll question. It can be specified instead of question_parse_mode.
optionsArray of InputPollOptionYesA JSON-serialized list of 1-12 answer options
is_anonymousBooleanOptionalTrue, if the poll needs to be anonymous, defaults to True
typeStringOptionalPoll type, “quiz” or “regular”, defaults to “regular”
allows_multiple_answersBooleanOptionalPass True, if the poll allows multiple answers, defaults to False
allows_revotingBooleanOptionalPass True, if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls
shuffle_optionsBooleanOptionalPass True, if the poll options must be shown in random order
allow_adding_optionsBooleanOptionalPass True, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes
hide_results_until_closesBooleanOptionalPass True, if poll results must be shown only after the poll closes
members_onlyBooleanOptionalPass True, if voting is limited to users who have been members of the chat where the poll is being sent for more than 24 hours; for channel chats only
country_codesArray of StringOptionalA JSON-serialized list of 0-12 two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote in the poll; for channel chats only. Use “FT” as a country code to allow users with anonymous numbers to vote. If omitted or empty, then users from any country can participate in the poll.
correct_option_idsArray of IntegerOptionalA JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode
explanationStringOptionalText that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing
explanation_parse_modeStringOptionalMode for parsing entities in the explanation. See formatting options for more details.
explanation_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the poll explanation. It can be specified instead of explanation_parse_mode.
explanation_mediaInputPollMediaOptionalMedia added to the quiz explanation
open_periodIntegerOptionalAmount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with close_date.
close_dateIntegerOptionalPoint in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with open_period.
is_closedBooleanOptionalPass True if the poll needs to be immediately closed. This can be useful for poll preview.
descriptionStringOptionalDescription of the poll to be sent, 0-1024 characters after entities parsing
description_parse_modeStringOptionalMode for parsing entities in the poll description. See formatting options for more details.
description_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode
mediaInputPollMediaOptionalMedia added to the poll description
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

sendChecklist

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot in the format @username
checklistInputChecklistYesA JSON-serialized object for the checklist to send
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message
reply_parametersReplyParametersOptionalA JSON-serialized object for description of the message to reply to
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for an inline keyboard
+

sendDice

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
emojiStringOptionalEmoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲”.
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idIntegerYesUnique identifier for the target private chat
message_thread_idIntegerOptionalUnique identifier for the target message thread
draft_idIntegerYesUnique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated.
textStringOptionalText of the message to be sent, 0-4096 characters after entities parsing. Pass an empty text to show a “Thinking…” placeholder.
parse_modeStringOptionalMode for parsing entities in the message text. See formatting options for more details.
entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
+

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.

+
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the action will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot or supergroup in the format @username. Channel chats and channel direct messages chats aren't supported.
message_thread_idIntegerOptionalUnique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only
actionStringYesType 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_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_idIntegerYesIdentifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.
reactionArray of ReactionTypeOptionalA JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.
is_bigBooleanOptionalPass True to set the reaction with a big animation
+

getUserProfilePhotos

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUnique identifier of the target user
offsetIntegerOptionalSequential number of the first photo to be returned. By default, all photos are returned.
limitIntegerOptionalLimits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.
+

getUserProfileAudios

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUnique identifier of the target user
offsetIntegerOptionalSequential number of the first audio to be returned. By default, all audios are returned.
limitIntegerOptionalLimits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUnique identifier of the target user
emoji_status_custom_emoji_idStringOptionalCustom emoji identifier of the emoji status to set. Pass an empty string to remove the status.
emoji_status_expiration_dateIntegerOptionalExpiration date of the emoji status, if any
+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
file_idStringYesFile identifier to get information about
+

Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.

+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target group or username of the target supergroup or channel in the format @username
user_idIntegerYesUnique identifier of the target user
until_dateIntegerOptionalDate when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.
revoke_messagesBooleanOptionalPass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target group or username of the target supergroup or channel in the format @username
user_idIntegerYesUnique identifier of the target user
only_if_bannedBooleanOptionalDo nothing if the user is not banned
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
user_idIntegerYesUnique identifier of the target user
permissionsChatPermissionsYesA JSON-serialized object for new user permissions
use_independent_chat_permissionsBooleanOptionalPass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
until_dateIntegerOptionalDate when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
user_idIntegerYesUnique identifier of the target user
is_anonymousBooleanOptionalPass True if the administrator's presence in the chat is hidden
can_manage_chatBooleanOptionalPass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.
can_delete_messagesBooleanOptionalPass True if the administrator can delete messages of other users
can_manage_video_chatsBooleanOptionalPass True if the administrator can manage video chats
can_restrict_membersBooleanOptionalPass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators.
can_promote_membersBooleanOptionalPass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)
can_change_infoBooleanOptionalPass True if the administrator can change chat title, photo and other settings
can_invite_usersBooleanOptionalPass True if the administrator can invite new users to the chat
can_post_storiesBooleanOptionalPass True if the administrator can post stories to the chat
can_edit_storiesBooleanOptionalPass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive
can_delete_storiesBooleanOptionalPass True if the administrator can delete stories posted by other users
can_post_messagesBooleanOptionalPass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only
can_edit_messagesBooleanOptionalPass True if the administrator can edit messages of other users and can pin messages; for channels only
can_pin_messagesBooleanOptionalPass True if the administrator can pin messages; for supergroups only
can_manage_topicsBooleanOptionalPass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
can_manage_direct_messagesBooleanOptionalPass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only
can_manage_tagsBooleanOptionalPass True if the administrator can edit the tags of regular members; for groups and supergroups only
+

setChatAdministratorCustomTitle

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
user_idIntegerYesUnique identifier of the target user
custom_titleStringYesNew custom title for the administrator; 0-16 characters, emoji are not allowed
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
user_idIntegerYesUnique identifier of the target user
tagStringOptionalNew tag for the member; 0-16 characters, emoji are not allowed
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
sender_chat_idIntegerYesUnique identifier of the target sender chat
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
sender_chat_idIntegerYesUnique identifier of the target sender chat
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
permissionsChatPermissionsYesA JSON-serialized object for new default chat permissions
use_independent_chat_permissionsBooleanOptionalPass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.
+

exportChatInviteLink

+

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
+
+

Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink or by calling the getChat method. If your bot needs to generate a new primary invite link replacing its previous one, use exportChatInviteLink again.

+
+

createChatInviteLink

+

Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
nameStringOptionalInvite link name; 0-32 characters
expire_dateIntegerOptionalPoint in time (Unix timestamp) when the link will expire
member_limitIntegerOptionalThe maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
creates_join_requestBooleanOptionalTrue, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified.
+

editChatInviteLink

+

Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
invite_linkStringYesThe invite link to edit
nameStringOptionalInvite link name; 0-32 characters
expire_dateIntegerOptionalPoint in time (Unix timestamp) when the link will expire
member_limitIntegerOptionalThe maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
creates_join_requestBooleanOptionalTrue, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified.
+

createChatSubscriptionInviteLink

+

Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target channel chat or username of the target channel in the format @username
nameStringOptionalInvite link name; 0-32 characters
subscription_periodIntegerYesThe number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).
subscription_priceIntegerYesThe amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000
+

editChatSubscriptionInviteLink

+

Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
invite_linkStringYesThe invite link to edit
nameStringOptionalInvite link name; 0-32 characters
+

revokeChatInviteLink

+

Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier of the target chat or username of the target channel in the format @username
invite_linkStringYesThe invite link to revoke
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
user_idIntegerYesUnique identifier of the target user
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
user_idIntegerYesUnique identifier of the target user
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
photoInputFileYesNew chat photo, uploaded using multipart/form-data
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
titleStringYesNew chat title, 1-128 characters
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
descriptionStringOptionalNew chat description, 0-255 characters
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be pinned
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
message_idIntegerYesIdentifier of a message to pin
disable_notificationBooleanOptionalPass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be unpinned
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
message_idIntegerOptionalIdentifier of the message to unpin. Required if business_connection_id is specified. If not specified, the most recent pinned message (by sending date) will be unpinned.
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
+

leaveChat

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup or channel in the format @username. Channel direct messages chats aren't supported; leave the corresponding channel instead.
+

getChat

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup or channel in the format @username
+

getChatAdministrators

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup or channel in the format @username
return_botsBooleanOptionalPass True to additionally receive all bots that are administrators of the chat. By default, bots other than the current bot are omitted.
+

getChatMemberCount

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup or channel in the format @username
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup or channel in the format @username
user_idIntegerYesUnique identifier of the target user
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUnique identifier for the target user
limitIntegerYesThe maximum number of messages to return; 1-20
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
sticker_set_nameStringYesName of the sticker set to be set as the group sticker set
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
+

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.

+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
nameStringYesTopic name, 1-128 characters
icon_colorIntegerOptionalColor of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F).
icon_custom_emoji_idStringOptionalUnique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
message_thread_idIntegerYesUnique identifier for the target message thread of the forum topic
nameStringOptionalNew topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept.
icon_custom_emoji_idStringOptionalNew unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
message_thread_idIntegerYesUnique identifier for the target message thread of the forum topic
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
message_thread_idIntegerYesUnique identifier for the target message thread of the forum topic
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
message_thread_idIntegerYesUnique identifier for the target message thread of the forum topic
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
message_thread_idIntegerYesUnique identifier for the target message thread of the forum topic
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
nameStringYesNew topic name, 1-128 characters
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
+

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.

+
+

Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
callback_query_idStringYesUnique identifier for the query to be answered
textStringOptionalText of the notification. If not specified, nothing will be shown to the user, 0-200 characters.
show_alertBooleanOptionalIf True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
urlStringOptionalURL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button.

Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.
cache_timeIntegerOptionalThe maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.
+

answerGuestQuery

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
guest_query_idStringYesUnique identifier for the query to be answered
resultInlineQueryResultYesA JSON-serialized object describing the message to be sent
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the chat or username of the channel in the format @username
user_idIntegerYesUnique identifier of the target user
+

getBusinessConnection

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
+

getManagedBotToken

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUser identifier of the managed bot whose token will be returned
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUser identifier of the managed bot whose token will be replaced
+

getManagedBotAccessSettings

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUser identifier of the managed bot whose access settings will be returned
+

setManagedBotAccessSettings

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUser identifier of the managed bot whose access settings will be changed
is_access_restrictedBooleanYesPass True, if only selected users can access the bot. The bot's owner can always access it.
added_user_idsArray of IntegerOptionalA JSON-serialized list of up to 10 identifiers of users who will have access to the bot in addition to its owner. Ignored if is_access_restricted is false.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
commandsArray of BotCommandYesA JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.
scopeBotCommandScopeOptionalA JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
language_codeStringOptionalA two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
scopeBotCommandScopeOptionalA JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.
language_codeStringOptionalA two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
scopeBotCommandScopeOptionalA JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.
language_codeStringOptionalA two-letter ISO 639-1 language code or an empty string
+

setMyName

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
nameStringOptionalNew bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.
language_codeStringOptionalA two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.
+

getMyName

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
language_codeStringOptionalA two-letter ISO 639-1 language code or an empty string
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
descriptionStringOptionalNew bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.
language_codeStringOptionalA two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.
+

getMyDescription

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
language_codeStringOptionalA two-letter ISO 639-1 language code or an empty string
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
short_descriptionStringOptionalNew short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.
language_codeStringOptionalA two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.
+

getMyShortDescription

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
language_codeStringOptionalA two-letter ISO 639-1 language code or an empty string
+

setMyProfilePhoto

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
photoInputProfilePhotoYesThe new profile photo to set
+

removeMyProfilePhoto

+

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

+

setChatMenuButton

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idIntegerOptionalUnique identifier for the target private chat. If not specified, the bot's default menu button will be changed.
menu_buttonMenuButtonOptionalA JSON-serialized object for the bot's new menu button. Defaults to MenuButtonDefault.
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idIntegerOptionalUnique identifier for the target private chat. If not specified, the bot's default menu button will be returned.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
rightsChatAdministratorRightsOptionalA JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.
for_channelsBooleanOptionalPass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.
+

getMyDefaultAdministratorRights

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
for_channelsBooleanOptionalPass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.
+

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.

+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerOptionalRequired if chat_id is not specified. Unique identifier of the target user who will receive the gift.
chat_idInteger or StringOptionalRequired if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @username) that will receive the gift.
gift_idStringYesIdentifier of the gift; limited gifts can't be sent to channel chats
pay_for_upgradeBooleanOptionalPass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver
textStringOptionalText that will be shown along with the gift; 0-128 characters
text_parse_modeStringOptionalMode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
text_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
+

giftPremiumSubscription

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUnique identifier of the target user who will receive a Telegram Premium subscription
month_countIntegerYesNumber of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12
star_countIntegerYesNumber of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months
textStringOptionalText that will be shown along with the service message about the subscription; 0-128 characters
text_parse_modeStringOptionalMode for parsing entities in the text. See formatting options for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
text_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.
+

verifyUser

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUnique identifier of the target user
custom_descriptionStringOptionalCustom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.
+

verifyChat

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username. Channel direct messages chats can't be verified.
custom_descriptionStringOptionalCustom description for the verification; 0-70 characters. Must be empty if the organization isn't allowed to provide a custom verification description.
+

removeUserVerification

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUnique identifier of the target user
+

removeChatVerification

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot or channel in the format @username
+

readBusinessMessage

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection on behalf of which to read the message
chat_idIntegerYesUnique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.
message_idIntegerYesUnique identifier of the message to mark as read
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection on behalf of which to delete the messages
message_idsArray of IntegerYesA JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted.
+

setBusinessAccountName

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
first_nameStringYesThe new value of the first name for the business account; 1-64 characters
last_nameStringOptionalThe new value of the last name for the business account; 0-64 characters
+

setBusinessAccountUsername

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
usernameStringOptionalThe new value of the username for the business account; 0-32 characters
+

setBusinessAccountBio

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
bioStringOptionalThe new value of the bio for the business account; 0-140 characters
+

setBusinessAccountProfilePhoto

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
photoInputProfilePhotoYesThe new profile photo to set
is_publicBooleanOptionalPass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.
+

removeBusinessAccountProfilePhoto

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
is_publicBooleanOptionalPass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
show_gift_buttonBooleanYesPass True, if a button for sending a gift to the user or by the business account must always be shown in the input field
accepted_gift_typesAcceptedGiftTypesYesTypes of gifts accepted by the business account
+

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.

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
star_countIntegerYesNumber of Telegram Stars to transfer; 1-10000
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
exclude_unsavedBooleanOptionalPass True to exclude gifts that aren't saved to the account's profile page
exclude_savedBooleanOptionalPass True to exclude gifts that are saved to the account's profile page
exclude_unlimitedBooleanOptionalPass True to exclude gifts that can be purchased an unlimited number of times
exclude_limited_upgradableBooleanOptionalPass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
exclude_limited_non_upgradableBooleanOptionalPass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
exclude_uniqueBooleanOptionalPass True to exclude unique gifts
exclude_from_blockchainBooleanOptionalPass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
sort_by_priceBooleanOptionalPass True to sort results by gift price instead of send date. Sorting is applied before pagination.
offsetStringOptionalOffset of the first entry to return as received from the previous request; use empty string to get the first chunk of results
limitIntegerOptionalThe maximum number of gifts to be returned; 1-100. Defaults to 100.
+

getUserGifts

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUnique identifier of the user
exclude_unlimitedBooleanOptionalPass True to exclude gifts that can be purchased an unlimited number of times
exclude_limited_upgradableBooleanOptionalPass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
exclude_limited_non_upgradableBooleanOptionalPass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
exclude_from_blockchainBooleanOptionalPass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
exclude_uniqueBooleanOptionalPass True to exclude unique gifts
sort_by_priceBooleanOptionalPass True to sort results by gift price instead of send date. Sorting is applied before pagination.
offsetStringOptionalOffset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
limitIntegerOptionalThe maximum number of gifts to be returned; 1-100. Defaults to 100.
+

getChatGifts

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target channel in the format @username
exclude_unsavedBooleanOptionalPass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.
exclude_savedBooleanOptionalPass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.
exclude_unlimitedBooleanOptionalPass True to exclude gifts that can be purchased an unlimited number of times
exclude_limited_upgradableBooleanOptionalPass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique
exclude_limited_non_upgradableBooleanOptionalPass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique
exclude_from_blockchainBooleanOptionalPass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram
exclude_uniqueBooleanOptionalPass True to exclude unique gifts
sort_by_priceBooleanOptionalPass True to sort results by gift price instead of send date. Sorting is applied before pagination.
offsetStringOptionalOffset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results
limitIntegerOptionalThe maximum number of gifts to be returned; 1-100. Defaults to 100.
+

convertGiftToStars

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
owned_gift_idStringYesUnique identifier of the regular gift that should be converted to Telegram Stars
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
owned_gift_idStringYesUnique identifier of the regular gift that should be upgraded to a unique one
keep_original_detailsBooleanOptionalPass True to keep the original gift text, sender and receiver in the upgraded gift
star_countIntegerOptionalThe amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
owned_gift_idStringYesUnique identifier of the regular gift that should be transferred
new_owner_chat_idIntegerYesUnique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.
star_countIntegerOptionalThe amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.
+

postStory

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
contentInputStoryContentYesContent of the story
active_periodIntegerYesPeriod after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400
captionStringOptionalCaption of the story, 0-2048 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the story caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
areasArray of StoryAreaOptionalA JSON-serialized list of clickable areas to be shown on the story
post_to_chat_pageBooleanOptionalPass True to keep the story accessible after it expires
protect_contentBooleanOptionalPass True if the content of the story must be protected from forwarding and screenshotting
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
from_chat_idIntegerYesUnique identifier of the chat which posted the story that should be reposted
from_story_idIntegerYesUnique identifier of the story that should be reposted
active_periodIntegerYesPeriod after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400
post_to_chat_pageBooleanOptionalPass True to keep the story accessible after it expires
protect_contentBooleanOptionalPass True if the content of the story must be protected from forwarding and screenshotting
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
story_idIntegerYesUnique identifier of the story to edit
contentInputStoryContentYesContent of the story
captionStringOptionalCaption of the story, 0-2048 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the story caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
areasArray of StoryAreaOptionalA JSON-serialized list of clickable areas to be shown on the story
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection
story_idIntegerYesUnique identifier of the story to delete
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
web_app_query_idStringYesUnique identifier for the query to be answered
resultInlineQueryResultYesA JSON-serialized object describing the message to be sent
+

savePreparedInlineMessage

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUnique identifier of the target user that can use the prepared message
resultInlineQueryResultYesA JSON-serialized object describing the message to be sent
allow_user_chatsBooleanOptionalPass True if the message can be sent to private chats with users
allow_bot_chatsBooleanOptionalPass True if the message can be sent to private chats with bots
allow_group_chatsBooleanOptionalPass True if the message can be sent to group and supergroup chats
allow_channel_chatsBooleanOptionalPass True if the message can be sent to channel chats
+

savePreparedKeyboardButton

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUnique identifier of the target user that can use the button
buttonKeyboardButtonYesA JSON-serialized object describing the button to be saved. The button must be of the type request_users, request_chat, or request_managed_bot.
+

Inline mode methods

+

Methods and objects used in the inline mode are described in the Inline mode section.

+

Updating messages

+

The following methods allow you to change an existing message in the message history instead of sending a new one with a result of an action. This is most useful for messages with inline keyboards using callback queries, but can also help reduce clutter in conversations with regular chat bots.

+

Please note, that it is currently only possible to edit messages without reply_markup or with inline keyboards.

+

editMessageText

+

Use this method to edit text 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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message to be edited was sent
chat_idInteger or StringOptionalRequired if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
message_idIntegerOptionalRequired if inline_message_id is not specified. Identifier of the message to edit.
inline_message_idStringOptionalRequired if chat_id and message_id are not specified. Identifier of the inline message.
textStringYesNew text of the message, 1-4096 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the message text. See formatting options for more details.
entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode
link_preview_optionsLinkPreviewOptionsOptionalLink preview generation options for the message
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for an inline keyboard
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message to be edited was sent
chat_idInteger or StringOptionalRequired if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
message_idIntegerOptionalRequired if inline_message_id is not specified. Identifier of the message to edit.
inline_message_idStringOptionalRequired if chat_id and message_id are not specified. Identifier of the inline message.
captionStringOptionalNew caption of the message, 0-1024 characters after entities parsing
parse_modeStringOptionalMode for parsing entities in the message caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptionalA JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptionalPass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for an inline keyboard
+

editMessageMedia

+

Use this method to edit animation, audio, document, live photo, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo, 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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message to be edited was sent
chat_idInteger or StringOptionalRequired if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
message_idIntegerOptionalRequired if inline_message_id is not specified. Identifier of the message to edit.
inline_message_idStringOptionalRequired if chat_id and message_id are not specified. Identifier of the inline message.
mediaInputMediaYesA JSON-serialized object for a new media content of the message
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for a new inline keyboard
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message to be edited was sent
chat_idInteger or StringOptionalRequired if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
message_idIntegerOptionalRequired if inline_message_id is not specified. Identifier of the message to edit.
inline_message_idStringOptionalRequired if chat_id and message_id are not specified. Identifier of the inline message.
latitudeFloatYesLatitude of new location
longitudeFloatYesLongitude of new location
live_periodIntegerOptionalNew period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged.
horizontal_accuracyFloatOptionalThe radius of uncertainty for the location, measured in meters; 0-1500
headingIntegerOptionalDirection in which the user is moving, in degrees. Must be between 1 and 360 if specified.
proximity_alert_radiusIntegerOptionalThe maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for a new inline keyboard
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message to be edited was sent
chat_idInteger or StringOptionalRequired if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
message_idIntegerOptionalRequired if inline_message_id is not specified. Identifier of the message with live location to stop.
inline_message_idStringOptionalRequired if chat_id and message_id are not specified. Identifier of the inline message.
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for a new inline keyboard
+

editMessageChecklist

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringYesUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot in the format @username
message_idIntegerYesUnique identifier for the target message
checklistInputChecklistYesA JSON-serialized object for the new checklist
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for the new inline keyboard for the message
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message to be edited was sent
chat_idInteger or StringOptionalRequired if inline_message_id is not specified. Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username.
message_idIntegerOptionalRequired if inline_message_id is not specified. Identifier of the message to edit.
inline_message_idStringOptionalRequired if chat_id and message_id are not specified. Identifier of the inline message.
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for an inline keyboard
+

stopPoll

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message to be edited was sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_idIntegerYesIdentifier of the original message with the poll
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for a new message inline keyboard
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idIntegerYesUnique identifier for the target direct messages chat
message_idIntegerYesIdentifier of a suggested post message to approve
send_dateIntegerOptionalPoint in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idIntegerYesUnique identifier for the target direct messages chat
message_idIntegerYesIdentifier of a suggested post message to decline
commentStringOptionalComment for the creator of the suggested post; 0-128 characters
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_idIntegerYesIdentifier of the message to delete
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_idsArray of IntegerYesA JSON-serialized list of 1-100 identifiers of messages to delete. See deleteMessage for limitations on which messages can be deleted.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
message_idIntegerYesIdentifier of the target message
user_idIntegerOptionalIdentifier of the user whose reaction will be removed, if the reaction was added by a user
actor_chat_idIntegerOptionalIdentifier of the chat whose reaction will be removed, if the reaction was added by a chat
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target supergroup in the format @username
user_idIntegerOptionalIdentifier of the user whose reactions will be removed, if the reactions were added by a user
actor_chat_idIntegerOptionalIdentifier of the chat whose reactions will be removed, if the reactions were added by a chat
+

Stickers

+

The following methods and objects allow your bot to handle stickers and sticker sets.

+

Sticker

+

This object represents a sticker.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
typeStringType of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.
widthIntegerSticker width
heightIntegerSticker height
is_animatedBooleanTrue, if the sticker is animated
is_videoBooleanTrue, if the sticker is a video sticker
thumbnailPhotoSizeOptional. Sticker thumbnail in the .WEBP or .JPG format
emojiStringOptional. Emoji associated with the sticker
set_nameStringOptional. Name of the sticker set to which the sticker belongs
premium_animationFileOptional. For premium regular stickers, premium animation for the sticker
mask_positionMaskPositionOptional. For mask stickers, the position where the mask should be placed
custom_emoji_idStringOptional. For custom emoji stickers, unique identifier of the custom emoji
needs_repaintingTrueOptional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium badge in emoji status, white color on chat photos, or another appropriate color in other places
file_sizeIntegerOptional. File size in bytes
+

StickerSet

+

This object represents a sticker set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
nameStringSticker set name
titleStringSticker set title
sticker_typeStringType of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”
stickersArray of StickerList of all set stickers
thumbnailPhotoSizeOptional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format
+

MaskPosition

+

This object describes the position on faces where a mask should be placed by default.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
pointStringThe part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.
x_shiftFloatShift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.
y_shiftFloatShift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.
scaleFloatMask scaling coefficient. For example, 2.0 means double size.
+

InputSticker

+

This object describes a sticker to be added to a sticker set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
stickerStringThe added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new file using multipart/form-data under <file_attach_name> name. Animated and video stickers can't be uploaded via HTTP URL. More information on Sending Files »
formatStringFormat of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, “video” for a .WEBM video
emoji_listArray of StringList of 1-20 emoji associated with the sticker
mask_positionMaskPositionOptional. Position where the mask should be placed on faces. For “mask” stickers only.
keywordsArray of StringOptional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only.
+

sendSticker

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
stickerInputFile or StringYesSticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files ». Video and animated stickers can't be sent via an HTTP URL.
emojiStringOptionalEmoji associated with the sticker; only for just uploaded stickers
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReplyOptionalAdditional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user.
+

getStickerSet

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
nameStringYesName of the sticker set
+

getCustomEmojiStickers

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
custom_emoji_idsArray of StringYesA JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUser identifier of sticker file owner
stickerInputFileYesA file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files »
sticker_formatStringYesFormat of the sticker, must be one of “static”, “animated”, “video”
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUser identifier of created sticker set owner
nameStringYesShort name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "_by_<bot_username>". <bot_username> is case insensitive. 1-64 characters.
titleStringYesSticker set title, 1-64 characters
stickersArray of InputStickerYesA JSON-serialized list of 1-50 initial stickers to be added to the sticker set
sticker_typeStringOptionalType of stickers in the set, pass “regular”, “mask”, or “custom_emoji”. By default, a regular sticker set is created.
needs_repaintingBooleanOptionalPass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUser identifier of sticker set owner
nameStringYesSticker set name
stickerInputStickerYesA JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.
+

setStickerPositionInSet

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
stickerStringYesFile identifier of the sticker
positionIntegerYesNew sticker position in the set, zero-based
+

deleteStickerFromSet

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
stickerStringYesFile identifier of the sticker
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUser identifier of the sticker set owner
nameStringYesSticker set name
old_stickerStringYesFile identifier of the replaced sticker
stickerInputStickerYesA JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
stickerStringYesFile identifier of the sticker
emoji_listArray of StringYesA JSON-serialized list of 1-20 emoji associated with the sticker
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
stickerStringYesFile identifier of the sticker
keywordsArray of StringOptionalA JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
stickerStringYesFile identifier of the sticker
mask_positionMaskPositionOptionalA JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.
+

setStickerSetTitle

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
nameStringYesSticker set name
titleStringYesSticker set title, 1-64 characters
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
nameStringYesSticker set name
user_idIntegerYesUser identifier of the sticker set owner
thumbnailInputFile or StringOptionalA .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.
formatStringYesFormat of the thumbnail, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation, or “video” for a .WEBM video
+

setCustomEmojiStickerSetThumbnail

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
nameStringYesSticker set name
custom_emoji_idStringOptionalCustom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail
+

deleteStickerSet

+

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

+ + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
nameStringYesSticker set name
+

Inline mode

+

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.

+

InlineQuery

+

This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idStringUnique identifier for this query
fromUserSender
queryStringText of the query (up to 256 characters)
offsetStringOffset of the results to be returned, can be controlled by the bot
chat_typeStringOptional. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat.
locationLocationOptional. Sender location, only for bots that request user location
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
inline_query_idStringYesUnique identifier for the answered query
resultsArray of InlineQueryResultYesA JSON-serialized array of results for the inline query
cache_timeIntegerOptionalThe maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
is_personalBooleanOptionalPass 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_offsetStringOptionalPass 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.
buttonInlineQueryResultsButtonOptionalA JSON-serialized object describing a button to be shown above inline query results
+

InlineQueryResultsButton

+

This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
textStringLabel text on the button
web_appWebAppInfoOptional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to switch back to the inline mode using the method switchInlineQuery inside the Web App.
start_parameterStringOptional. Deep-linking parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.

Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.
+

InlineQueryResult

+

This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:

+ +

Note: All URLs passed in inline query results will be available to end users and therefore must be assumed to be public.

+

InlineQueryResultArticle

+

Represents a link to an article or web page.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be article
idStringUnique identifier for this result, 1-64 Bytes
titleStringTitle of the result
input_message_contentInputMessageContentContent of the message to be sent
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
urlStringOptional. URL of the result
descriptionStringOptional. Short description of the result
thumbnail_urlStringOptional. Url of the thumbnail for the result
thumbnail_widthIntegerOptional. Thumbnail width
thumbnail_heightIntegerOptional. Thumbnail height
+

InlineQueryResultPhoto

+

Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be photo
idStringUnique identifier for this result, 1-64 bytes
photo_urlStringA valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB.
thumbnail_urlStringURL of the thumbnail for the photo
photo_widthIntegerOptional. Width of the photo
photo_heightIntegerOptional. Height of the photo
titleStringOptional. Title for the result
descriptionStringOptional. Short description of the result
captionStringOptional. Caption of the photo to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the photo caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the photo
+

InlineQueryResultGif

+

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 use input_message_content to send a message with the specified content instead of the animation.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be gif
idStringUnique identifier for this result, 1-64 bytes
gif_urlStringA valid URL for the GIF file
gif_widthIntegerOptional. Width of the GIF
gif_heightIntegerOptional. Height of the GIF
gif_durationIntegerOptional. Duration of the GIF in seconds
thumbnail_urlStringURL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
thumbnail_mime_typeStringOptional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”.
titleStringOptional. Title for the result
captionStringOptional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the GIF animation
+

InlineQueryResultMpeg4Gif

+

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 use input_message_content to send a message with the specified content instead of the animation.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be mpeg4_gif
idStringUnique identifier for this result, 1-64 bytes
mpeg4_urlStringA valid URL for the MPEG4 file
mpeg4_widthIntegerOptional. Video width
mpeg4_heightIntegerOptional. Video height
mpeg4_durationIntegerOptional. Video duration in seconds
thumbnail_urlStringURL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
thumbnail_mime_typeStringOptional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”.
titleStringOptional. Title for the result
captionStringOptional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the video animation
+

InlineQueryResultVideo

+

Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

+
+

If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be video
idStringUnique identifier for this result, 1-64 bytes
video_urlStringA valid URL for the embedded video player or video file
mime_typeStringMIME type of the content of the video URL, “text/html” or “video/mp4”
thumbnail_urlStringURL of the thumbnail (JPEG only) for the video
titleStringTitle for the result
captionStringOptional. Caption of the video to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the video caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
video_widthIntegerOptional. Video width
video_heightIntegerOptional. Video height
video_durationIntegerOptional. Video duration in seconds
descriptionStringOptional. Short description of the result
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).
+

InlineQueryResultAudio

+

Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be audio
idStringUnique identifier for this result, 1-64 bytes
audio_urlStringA valid URL for the audio file
titleStringTitle
captionStringOptional. Caption, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the audio caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
performerStringOptional. Performer
audio_durationIntegerOptional. Audio duration in seconds
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the audio
+

InlineQueryResultVoice

+

Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be voice
idStringUnique identifier for this result, 1-64 bytes
voice_urlStringA valid URL for the voice recording
titleStringRecording title
captionStringOptional. Caption, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the voice message caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
voice_durationIntegerOptional. Recording duration in seconds
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the voice recording
+

InlineQueryResultDocument

+

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be document
idStringUnique identifier for this result, 1-64 bytes
titleStringTitle for the result
captionStringOptional. Caption of the document to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the document caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
document_urlStringA valid URL for the file
mime_typeStringMIME type of the content of the file, either “application/pdf” or “application/zip”
descriptionStringOptional. Short description of the result
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the file
thumbnail_urlStringOptional. URL of the thumbnail (JPEG only) for the file
thumbnail_widthIntegerOptional. Thumbnail width
thumbnail_heightIntegerOptional. Thumbnail height
+

InlineQueryResultLocation

+

Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be location
idStringUnique identifier for this result, 1-64 Bytes
latitudeFloatLocation latitude in degrees
longitudeFloatLocation longitude in degrees
titleStringLocation title
horizontal_accuracyFloatOptional. The radius of uncertainty for the location, measured in meters; 0-1500
live_periodIntegerOptional. Period in seconds during which the location can be updated, must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely
headingIntegerOptional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
proximity_alert_radiusIntegerOptional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the location
thumbnail_urlStringOptional. Url of the thumbnail for the result
thumbnail_widthIntegerOptional. Thumbnail width
thumbnail_heightIntegerOptional. Thumbnail height
+

InlineQueryResultVenue

+

Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be venue
idStringUnique identifier for this result, 1-64 Bytes
latitudeFloatLatitude of the venue location in degrees
longitudeFloatLongitude of the venue location in degrees
titleStringTitle of the venue
addressStringAddress of the venue
foursquare_idStringOptional. Foursquare identifier of the venue if known
foursquare_typeStringOptional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
google_place_idStringOptional. Google Places identifier of the venue
google_place_typeStringOptional. Google Places type of the venue. (See supported types.)
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the venue
thumbnail_urlStringOptional. Url of the thumbnail for the result
thumbnail_widthIntegerOptional. Thumbnail width
thumbnail_heightIntegerOptional. Thumbnail height
+

InlineQueryResultContact

+

Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be contact
idStringUnique identifier for this result, 1-64 Bytes
phone_numberStringContact's phone number
first_nameStringContact's first name
last_nameStringOptional. Contact's last name
vcardStringOptional. Additional data about the contact in the form of a vCard, 0-2048 bytes
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the contact
thumbnail_urlStringOptional. Url of the thumbnail for the result
thumbnail_widthIntegerOptional. Thumbnail width
thumbnail_heightIntegerOptional. Thumbnail height
+

InlineQueryResultGame

+

Represents a Game.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be game
idStringUnique identifier for this result, 1-64 bytes
game_short_nameStringShort name of the game
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
+

InlineQueryResultCachedPhoto

+

Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be photo
idStringUnique identifier for this result, 1-64 bytes
photo_file_idStringA valid file identifier of the photo
titleStringOptional. Title for the result
descriptionStringOptional. Short description of the result
captionStringOptional. Caption of the photo to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the photo caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the photo
+

InlineQueryResultCachedGif

+

Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be gif
idStringUnique identifier for this result, 1-64 bytes
gif_file_idStringA valid file identifier for the GIF file
titleStringOptional. Title for the result
captionStringOptional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the GIF animation
+

InlineQueryResultCachedMpeg4Gif

+

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be mpeg4_gif
idStringUnique identifier for this result, 1-64 bytes
mpeg4_file_idStringA valid file identifier for the MPEG4 file
titleStringOptional. Title for the result
captionStringOptional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the video animation
+

InlineQueryResultCachedSticker

+

Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be sticker
idStringUnique identifier for this result, 1-64 bytes
sticker_file_idStringA valid file identifier of the sticker
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the sticker
+

InlineQueryResultCachedDocument

+

Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be document
idStringUnique identifier for this result, 1-64 bytes
titleStringTitle for the result
document_file_idStringA valid file identifier for the file
descriptionStringOptional. Short description of the result
captionStringOptional. Caption of the document to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the document caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the file
+

InlineQueryResultCachedVideo

+

Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be video
idStringUnique identifier for this result, 1-64 bytes
video_file_idStringA valid file identifier for the video file
titleStringTitle for the result
descriptionStringOptional. Short description of the result
captionStringOptional. Caption of the video to be sent, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the video caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
show_caption_above_mediaBooleanOptional. Pass True, if the caption must be shown above the message media
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the video
+

InlineQueryResultCachedVoice

+

Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be voice
idStringUnique identifier for this result, 1-64 bytes
voice_file_idStringA valid file identifier for the voice message
titleStringVoice message title
captionStringOptional. Caption, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the voice message caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the voice message
+

InlineQueryResultCachedAudio

+

Represents a link to an MP3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the result, must be audio
idStringUnique identifier for this result, 1-64 bytes
audio_file_idStringA valid file identifier for the audio file
captionStringOptional. Caption, 0-1024 characters after entities parsing
parse_modeStringOptional. Mode for parsing entities in the audio caption. See formatting options for more details.
caption_entitiesArray of MessageEntityOptional. List of special entities that appear in the caption, which can be specified instead of parse_mode
reply_markupInlineKeyboardMarkupOptional. Inline keyboard attached to the message
input_message_contentInputMessageContentOptional. Content of the message to be sent instead of the audio
+

InputMessageContent

+

This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:

+ +

InputTextMessageContent

+

Represents the content of a text message to be sent as the result of an inline query.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
message_textStringText of the message to be sent, 1-4096 characters
parse_modeStringOptional. Mode for parsing entities in the message text. See formatting options for more details.
entitiesArray of MessageEntityOptional. List of special entities that appear in message text, which can be specified instead of parse_mode
link_preview_optionsLinkPreviewOptionsOptional. Link preview generation options for the message
+

InputLocationMessageContent

+

Represents the content of a location message to be sent as the result of an inline query.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
latitudeFloatLatitude of the location in degrees
longitudeFloatLongitude of the location in degrees
horizontal_accuracyFloatOptional. The radius of uncertainty for the location, measured in meters; 0-1500
live_periodIntegerOptional. Period in seconds during which the location can be updated, must be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely
headingIntegerOptional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
proximity_alert_radiusIntegerOptional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
+

InputVenueMessageContent

+

Represents the content of a venue message to be sent as the result of an inline query.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
latitudeFloatLatitude of the venue in degrees
longitudeFloatLongitude of the venue in degrees
titleStringName of the venue
addressStringAddress of the venue
foursquare_idStringOptional. Foursquare identifier of the venue, if known
foursquare_typeStringOptional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
google_place_idStringOptional. Google Places identifier of the venue
google_place_typeStringOptional. Google Places type of the venue. (See supported types.)
+

InputContactMessageContent

+

Represents the content of a contact message to be sent as the result of an inline query.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
phone_numberStringContact's phone number
first_nameStringContact's first name
last_nameStringOptional. Contact's last name
vcardStringOptional. Additional data about the contact in the form of a vCard, 0-2048 bytes
+

InputInvoiceMessageContent

+

Represents the content of an invoice message to be sent as the result of an inline query.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
titleStringProduct name, 1-32 characters
descriptionStringProduct description, 1-255 characters
payloadStringBot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
provider_tokenStringOptional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
currencyStringThree-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
pricesArray of LabeledPricePrice breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
max_tip_amountIntegerOptional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
suggested_tip_amountsArray of IntegerOptional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
provider_dataStringOptional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.
photo_urlStringOptional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
photo_sizeIntegerOptional. Photo size in bytes
photo_widthIntegerOptional. Photo width
photo_heightIntegerOptional. Photo height
need_nameBooleanOptional. Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
need_phone_numberBooleanOptional. Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
need_emailBooleanOptional. Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
need_shipping_addressBooleanOptional. Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
send_phone_number_to_providerBooleanOptional. Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
send_email_to_providerBooleanOptional. Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
is_flexibleBooleanOptional. Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
+

ChosenInlineResult

+

Represents a result of an inline query that was chosen by the user and sent to their chat partner.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
result_idStringThe unique identifier for the result that was chosen
fromUserThe user that chose the result
locationLocationOptional. Sender location, only for bots that require user location
inline_message_idStringOptional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.
queryStringThe query that was used to obtain the result
+

Note: It is necessary to enable inline feedback via @BotFather in order to receive these objects in updates.

+

Payments

+

Your bot can accept payments from Telegram users. Please see the introduction to payments for more details on the process and how to set up payments for your bot.

+

sendInvoice

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
direct_messages_topic_idIntegerOptionalIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
titleStringYesProduct name, 1-32 characters
descriptionStringYesProduct description, 1-255 characters
payloadStringYesBot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
provider_tokenStringOptionalPayment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
currencyStringYesThree-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
pricesArray of LabeledPriceYesPrice breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
max_tip_amountIntegerOptionalThe maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
suggested_tip_amountsArray of IntegerOptionalA JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
start_parameterStringOptionalUnique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter.
provider_dataStringOptionalJSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
photo_urlStringOptionalURL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.
photo_sizeIntegerOptionalPhoto size in bytes
photo_widthIntegerOptionalPhoto width
photo_heightIntegerOptionalPhoto height
need_nameBooleanOptionalPass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
need_phone_numberBooleanOptionalPass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
need_emailBooleanOptionalPass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
need_shipping_addressBooleanOptionalPass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
send_phone_number_to_providerBooleanOptionalPass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
send_email_to_providerBooleanOptionalPass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
is_flexibleBooleanOptionalPass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
suggested_post_parametersSuggestedPostParametersOptionalA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.
+

createInvoiceLink

+

Use this method to create a link for an invoice. Returns the created invoice link as String on success.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.
titleStringYesProduct name, 1-32 characters
descriptionStringYesProduct description, 1-255 characters
payloadStringYesBot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.
provider_tokenStringOptionalPayment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
currencyStringYesThree-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
pricesArray of LabeledPriceYesPrice breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
subscription_periodIntegerOptionalThe number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.
max_tip_amountIntegerOptionalThe maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.
suggested_tip_amountsArray of IntegerOptionalA JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
provider_dataStringOptionalJSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.
photo_urlStringOptionalURL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
photo_sizeIntegerOptionalPhoto size in bytes
photo_widthIntegerOptionalPhoto width
photo_heightIntegerOptionalPhoto height
need_nameBooleanOptionalPass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.
need_phone_numberBooleanOptionalPass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.
need_emailBooleanOptionalPass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.
need_shipping_addressBooleanOptionalPass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.
send_phone_number_to_providerBooleanOptionalPass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.
send_email_to_providerBooleanOptionalPass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.
is_flexibleBooleanOptionalPass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
shipping_query_idStringYesUnique identifier for the query to be answered
okBooleanYesPass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
shipping_optionsArray of ShippingOptionOptionalRequired if ok is True. A JSON-serialized array of available shipping options.
error_messageStringOptionalRequired if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. “Sorry, delivery to your desired address is unavailable”). Telegram will display this message to the user.
+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
pre_checkout_query_idStringYesUnique identifier for the query to be answered
okBooleanYesSpecify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.
error_messageStringOptionalRequired if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.
+

getMyStarBalance

+

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

+

getStarTransactions

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
offsetIntegerOptionalNumber of transactions to skip in the response
limitIntegerOptionalThe maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.
+

refundStarPayment

+

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

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesIdentifier of the user whose payment will be refunded
telegram_payment_charge_idStringYesTelegram payment identifier
+

editUserStarSubscription

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesIdentifier of the user whose subscription will be edited
telegram_payment_charge_idStringYesTelegram payment identifier for the subscription
is_canceledBooleanYesPass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.
+

LabeledPrice

+

This object represents a portion of the price for goods or services.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
labelStringPortion label
amountIntegerPrice of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
+

Invoice

+

This object contains basic information about an invoice.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
titleStringProduct name
descriptionStringProduct description
start_parameterStringUnique bot deep-linking parameter that can be used to generate this invoice
currencyStringThree-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
total_amountIntegerTotal price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
+

ShippingAddress

+

This object represents a shipping address.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
country_codeStringTwo-letter ISO 3166-1 alpha-2 country code
stateStringState, if applicable
cityStringCity
street_line1StringFirst line for the address
street_line2StringSecond line for the address
post_codeStringAddress post code
+

OrderInfo

+

This object represents information about an order.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
nameStringOptional. User name
phone_numberStringOptional. User's phone number
emailStringOptional. User email
shipping_addressShippingAddressOptional. User shipping address
+

ShippingOption

+

This object represents one shipping option.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idStringShipping option identifier
titleStringOption title
pricesArray of LabeledPriceList of price portions
+

SuccessfulPayment

+

This object contains basic information about a successful payment. Note that if the buyer initiates a chargeback with the relevant payment provider following this transaction, the funds may be debited from your balance. This is outside of Telegram's control.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
currencyStringThree-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
total_amountIntegerTotal price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
invoice_payloadStringBot-specified invoice payload
subscription_expiration_dateIntegerOptional. Expiration date of the subscription, in Unix time; for recurring payments only
is_recurringTrueOptional. True, if the payment is a recurring payment for a subscription
is_first_recurringTrueOptional. True, if the payment is the first payment for a subscription
shipping_option_idStringOptional. Identifier of the shipping option chosen by the user
order_infoOrderInfoOptional. Order information provided by the user
telegram_payment_charge_idStringTelegram payment identifier
provider_payment_charge_idStringProvider payment identifier
+

RefundedPayment

+

This object contains basic information about a refunded payment.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
currencyStringThree-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently, always “XTR”.
total_amountIntegerTotal refunded price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45, total_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
invoice_payloadStringBot-specified invoice payload
telegram_payment_charge_idStringTelegram payment identifier
provider_payment_charge_idStringOptional. Provider payment identifier
+

ShippingQuery

+

This object contains information about an incoming shipping query.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idStringUnique query identifier
fromUserUser who sent the query
invoice_payloadStringBot-specified invoice payload
shipping_addressShippingAddressUser specified shipping address
+

PreCheckoutQuery

+

This object contains information about an incoming pre-checkout query.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idStringUnique query identifier
fromUserUser who sent the query
currencyStringThree-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
total_amountIntegerTotal price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
invoice_payloadStringBot-specified invoice payload
shipping_option_idStringOptional. Identifier of the shipping option chosen by the user
order_infoOrderInfoOptional. Order information provided by the user
+

PaidMediaPurchased

+

This object contains information about a paid media purchase.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
fromUserUser who purchased the media
paid_media_payloadStringBot-specified paid media payload
+

RevenueWithdrawalState

+

This object describes the state of a revenue withdrawal operation. Currently, it can be one of

+ +

RevenueWithdrawalStatePending

+

The withdrawal is in progress.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the state, always “pending”
+

RevenueWithdrawalStateSucceeded

+

The withdrawal succeeded.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the state, always “succeeded”
dateIntegerDate the withdrawal was completed in Unix time
urlStringAn HTTPS URL that can be used to see transaction details
+

RevenueWithdrawalStateFailed

+

The withdrawal failed and the transaction was refunded.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the state, always “failed”
+

AffiliateInfo

+

Contains information about the affiliate that received a commission via this transaction.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
affiliate_userUserOptional. The bot or the user that received an affiliate commission if it was received by a bot or a user
affiliate_chatChatOptional. The chat that received an affiliate commission if it was received by a chat
commission_per_milleIntegerThe number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users
amountIntegerInteger amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds
nanostar_amountIntegerOptional. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds
+

TransactionPartner

+

This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of

+ +

TransactionPartnerUser

+

Describes a transaction with a user.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the transaction partner, always “user”
transaction_typeStringType of the transaction, currently one of “invoice_payment” for payments via invoices, “paid_media_payment” for payments for paid media, “gift_purchase” for gifts sent by the bot, “premium_purchase” for Telegram Premium subscriptions gifted by the bot, “business_account_transfer” for direct transfers from managed business accounts
userUserInformation about the user
affiliateAffiliateInfoOptional. Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions.
invoice_payloadStringOptional. Bot-specified invoice payload. Can be available only for “invoice_payment” transactions.
subscription_periodIntegerOptional. The duration of the paid subscription. Can be available only for “invoice_payment” transactions.
paid_mediaArray of PaidMediaOptional. Information about the paid media bought by the user; for “paid_media_payment” transactions only
paid_media_payloadStringOptional. Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions.
giftGiftOptional. The gift sent to the user by the bot; for “gift_purchase” transactions only
premium_subscription_durationIntegerOptional. Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only
+

TransactionPartnerChat

+

Describes a transaction with a chat.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the transaction partner, always “chat”
chatChatInformation about the chat
giftGiftOptional. The gift sent to the chat by the bot
+

TransactionPartnerAffiliateProgram

+

Describes the affiliate program that issued the affiliate commission received via this transaction.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the transaction partner, always “affiliate_program”
sponsor_userUserOptional. Information about the bot that sponsored the affiliate program
commission_per_milleIntegerThe number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users
+

TransactionPartnerFragment

+

Describes a withdrawal transaction with Fragment.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the transaction partner, always “fragment”
withdrawal_stateRevenueWithdrawalStateOptional. State of the transaction if the transaction is outgoing
+

TransactionPartnerTelegramAds

+

Describes a withdrawal transaction to the Telegram Ads platform.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the transaction partner, always “telegram_ads”
+

TransactionPartnerTelegramApi

+

Describes a transaction with payment for paid broadcasting.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the transaction partner, always “telegram_api”
request_countIntegerThe number of successful requests that exceeded regular limits and were therefore billed
+

TransactionPartnerOther

+

Describes a transaction with an unknown source or recipient.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringType of the transaction partner, always “other”
+

StarTransaction

+

Describes a Telegram Star transaction. Note that if the buyer initiates a chargeback with the payment provider from whom they acquired Stars (e.g., Apple, Google) following this transaction, the refunded Stars will be deducted from the bot's balance. This is outside of Telegram's control.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
idStringUnique identifier of the transaction. Coincides with the identifier of the original transaction for refund transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from users.
amountIntegerInteger amount of Telegram Stars transferred by the transaction
nanostar_amountIntegerOptional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999
dateIntegerDate the transaction was created in Unix time
sourceTransactionPartnerOptional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions.
receiverTransactionPartnerOptional. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only for outgoing transactions.
+

StarTransactions

+

Contains a list of Telegram Star transactions.

+ + + + + + + + + + + + + + + +
FieldTypeDescription
transactionsArray of StarTransactionThe list of transactions
+

Telegram Passport

+

Telegram Passport is a unified authorization method for services that require personal identification. Users can upload their documents once, then instantly share their data with services that require real-world ID (finance, ICOs, etc.). Please see the manual for details.

+

PassportData

+

Describes Telegram Passport data shared with the bot by the user.

+ + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
dataArray of EncryptedPassportElementArray with information about documents and other Telegram Passport elements that was shared with the bot
credentialsEncryptedCredentialsEncrypted credentials required to decrypt the data
+

PassportFile

+

This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
file_idStringIdentifier for this file, which can be used to download or reuse the file
file_unique_idStringUnique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
file_sizeIntegerFile size in bytes
file_dateIntegerUnix time when the file was uploaded
+

EncryptedPassportElement

+

Describes documents or other Telegram Passport elements shared with the bot by the user.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
typeStringElement type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.
dataStringOptional. Base64-encoded encrypted Telegram Passport element data provided by the user; available only for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.
phone_numberStringOptional. User's verified phone number; available only for “phone_number” type
emailStringOptional. User's verified email address; available only for “email” type
filesArray of PassportFileOptional. Array of encrypted files with documents provided by the user; available only for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
front_sidePassportFileOptional. Encrypted file with the front side of the document, provided by the user; available only for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
reverse_sidePassportFileOptional. Encrypted file with the reverse side of the document, provided by the user; available only for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
selfiePassportFileOptional. Encrypted file with the selfie of the user holding a document, provided by the user; available if requested for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
translationArray of PassportFileOptional. Array of encrypted files with translated versions of documents provided by the user; available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
hashStringBase64-encoded element hash for using in PassportElementErrorUnspecified
+

EncryptedCredentials

+

Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
dataStringBase64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication
hashStringBase64-encoded data hash for data authentication
secretStringBase64-encoded secret, encrypted with the bot's public RSA key, required for data decryption
+

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.

+

Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues.

+ + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUser identifier
errorsArray of PassportElementErrorYesA JSON-serialized array describing the errors
+

PassportElementError

+

This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:

+ +

PassportElementErrorDataField

+

Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringError source, must be data
typeStringThe section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”
field_nameStringName of the data field which has the error
data_hashStringBase64-encoded data hash
messageStringError message
+

PassportElementErrorFrontSide

+

Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringError source, must be front_side
typeStringThe section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”
file_hashStringBase64-encoded hash of the file with the front side of the document
messageStringError message
+

PassportElementErrorReverseSide

+

Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringError source, must be reverse_side
typeStringThe section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card”
file_hashStringBase64-encoded hash of the file with the reverse side of the document
messageStringError message
+

PassportElementErrorSelfie

+

Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringError source, must be selfie
typeStringThe section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”
file_hashStringBase64-encoded hash of the file with the selfie
messageStringError message
+

PassportElementErrorFile

+

Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringError source, must be file
typeStringThe section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
file_hashStringBase64-encoded file hash
messageStringError message
+

PassportElementErrorFiles

+

Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringError source, must be files
typeStringThe section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
file_hashesArray of StringList of base64-encoded file hashes
messageStringError message
+

PassportElementErrorTranslationFile

+

Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringError source, must be translation_file
typeStringType of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
file_hashStringBase64-encoded file hash
messageStringError message
+

PassportElementErrorTranslationFiles

+

Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringError source, must be translation_files
typeStringType of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”
file_hashesArray of StringList of base64-encoded file hashes
messageStringError message
+

PassportElementErrorUnspecified

+

Represents an issue in an unspecified place. The error is considered resolved when new data is added.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
sourceStringError source, must be unspecified
typeStringType of element of the user's Telegram Passport which has the issue
element_hashStringBase64-encoded element hash
messageStringError message
+

Games

+

Your bot can offer users HTML5 games to play solo or to compete against each other in groups and one-on-one chats. Create games via @BotFather using the /newgame command. Please note that this kind of power requires responsibility: you will need to accept the terms for each game that your bots will be offering.

+
    +
  • Games are a new type of content on Telegram, represented by the Game and InlineQueryResultGame objects.
    • +
  • Once you've created a game via BotFather, you can send games to chats as regular messages using the sendGame method, or use inline mode with InlineQueryResultGame.
    • +
  • If you send the game message without any buttons, it will automatically have a 'Play GameName' button. When this button is pressed, your bot gets a CallbackQuery with the game_short_name of the requested game. You provide the correct URL for this particular user and the app opens the game in the in-app browser.
    • +
  • You can manually add multiple buttons to your game message. Please note that the first button in the first row must always launch the game, using the field callback_game in InlineKeyboardButton. You can add extra buttons according to taste: e.g., for a description of the rules, or to open the game's official community.
    • +
  • To make your game more attractive, you can upload a GIF animation that demonstrates the game to the users via BotFather (see Lumberjack for example).
    • +
  • A game message will also display high scores for the current chat. Use setGameScore to post high scores to the chat with the game, add the disable_edit_message parameter to disable automatic update of the message with the current scoreboard.
    • +
  • Use getGameHighScores to get data for in-game high score tables.
    • +
  • You can also add an extra sharing button for users to share their best score to different chats.
    • +
  • For examples of what can be done using this new stuff, check the @gamebot and @gamee bots.
    • +
+

sendGame

+

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

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
business_connection_idStringOptionalUnique identifier of the business connection on behalf of which the message will be sent
chat_idInteger or StringYesUnique identifier for the target chat or username of the target bot in the format @username. Games can't be sent to channel direct messages chats and channel chats.
message_thread_idIntegerOptionalUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
game_short_nameStringYesShort name of the game, serves as the unique identifier for the game. Set up your games via @BotFather.
disable_notificationBooleanOptionalSends the message silently. Users will receive a notification with no sound.
protect_contentBooleanOptionalProtects the contents of the sent message from forwarding and saving
allow_paid_broadcastBooleanOptionalPass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance.
message_effect_idStringOptionalUnique identifier of the message effect to be added to the message; for private chats only
reply_parametersReplyParametersOptionalDescription of the message to reply to
reply_markupInlineKeyboardMarkupOptionalA JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.
+

Game

+

This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
titleStringTitle of the game
descriptionStringDescription of the game
photoArray of PhotoSizePhoto that will be displayed in the game message in chats
textStringOptional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.
text_entitiesArray of MessageEntityOptional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
animationAnimationOptional. Animation that will be displayed in the game message in chats. Upload via BotFather.
+

CallbackGame

+

A placeholder, currently holds no information. Use BotFather to set up your game.

+

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.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesUser identifier
scoreIntegerYesNew score, must be non-negative
forceBooleanOptionalPass True if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters.
disable_edit_messageBooleanOptionalPass True if the game message should not be automatically edited to include the current scoreboard
chat_idIntegerOptionalRequired if inline_message_id is not specified. Unique identifier for the target chat.
message_idIntegerOptionalRequired if inline_message_id is not specified. Identifier of the sent message.
inline_message_idStringOptionalRequired if chat_id and message_id are not specified. Identifier of the inline message.
+

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.

+
+

This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and their neighbors are not among them. Please note that this behavior is subject to change.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterTypeRequiredDescription
user_idIntegerYesTarget user id
chat_idIntegerOptionalRequired if inline_message_id is not specified. Unique identifier for the target chat.
message_idIntegerOptionalRequired if inline_message_id is not specified. Identifier of the sent message.
inline_message_idStringOptionalRequired if chat_id and message_id are not specified. Identifier of the inline message.
+

GameHighScore

+

This object represents one row of the high scores table for a game.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
positionIntegerPosition in high score table for the game
userUserUser
scoreIntegerScore
+
+

And that's about all we've got for now.
If you've got any questions, please check out our Bot FAQ »

+
+ +
+ +
+
+
+
+
+
Telegram
+
+ Telegram is a cloud-based mobile and desktop messaging app with a focus on security and speed. +
+ +
+
About
+ +
+
+
Mobile Apps
+ +
+
+
Desktop Apps
+ +
+
+
Platform
+ +
+
+
+
+
About
+
+
+
Blog
+
+
+
Press
+
+
+
Safety
+
+
+
+
+ + + + + + + +