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.
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.
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.
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.
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 admin rights. Returns True on success.
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
admin 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.
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.- 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 permission in a supergroup or a channel, it can delete
any message there.Returns True on success.
Use this method to edit captions of messages. On success, if edited message is
sent by the bot, the edited Message is returned, otherwise True is returned.
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 was sent by the bot,
the edited Message is returned, otherwise True is returned.
Use this method to edit animation, audio, document, photo, or video messages. If
a message is a part of a message album, then it can be edited only to a photo or
a video. Otherwise, message type can be changed arbitrarily. When inline message
is edited, new file can’t be uploaded. Use previously uploaded file via its
file_id or specify a URL. On success, if the edited message was sent by the bot,
the edited Message is returned, otherwise True is returned.
Use this method to edit only the reply markup of messages. On success, if edited
message is sent by the bot, the edited Message is returned, otherwise True is
returned.
Use this method to edit text and game messages. On success, if edited message is
sent by the bot, the edited Message is returned, otherwise True is returned.
Contains data required for decrypting and authenticating
EncryptedPassportElement. See the Telegram Passport Documentation for a complete
description of the data decryption and authentication processes.
Use this method to generate a new invite link for a chat; any previously
generated link is revoked. The bot must be an administrator in the chat for this
to work and must have the appropriate admin rights. Returns the new invite link
as String on success.
This object represents a file ready to be downloaded. The file can be downloaded
via the link https://api.telegram.org/file/bot/<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.
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.
Use this method to get up to date information about the chat (current name of
the user for one-on-one conversations, current username of a user, group or
channel, etc.). Returns a Chat object on success.
Use this method to get a list of administrators in a chat. On success, returns
an Array of ChatMember objects that contains information about all chat
administrators except other bots. If the chat is a group or a supergroup and no
administrators were appointed, only the creator will be returned.
Use this method to get basic info about a file and prepare it for downloading.
For the moment, bots can download files of up to 20MB in size. On success, a
File object is returned. The file can then be downloaded via the link
https://api.telegram.org/file/bot/<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.
Use this method to get data for high score tables. Will return the score of the
specified user and several of his neighbors in a game. On success, returns an
Array of GameHighScore objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
This object represents one button of the reply keyboard. For simple text buttons
String can be used instead of this object to specify text of the button.
Optional fields are mutually exclusive.
Use this method to kick a user from a group, a supergroup or a channel. In the
case of supergroups and channels, the user will not be able to return to the
group on their own using invite links, etc., unless unbanned first. The bot must
be an administrator in the chat for this to work and must have the appropriate
admin rights. Returns True on success.
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:
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.
Use this method to pin a message in a group, a supergroup, or a channel. The bot
must be an administrator in the chat for this to work and must have the
‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin
right in the channel. Returns True on success.
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 admin rights. Pass False for all boolean parameters to demote a
user. Returns True on success.
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).
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
admin rights. Pass True for all boolean parameters to lift restrictions from a
user. Returns True on success.
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.
Use this method to send audio files, if you want Telegram clients to display
them in the music player. Your audio must be in the .mp3 format. On success, the
sent Message is returned. Bots can currently send audio files of up to 50 MB in
size, this limit may be changed in the future.
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.
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.
Use this method to send video files, Telegram clients support mp4 videos (other
formats may be sent as Document). On success, the sent Message is returned. Bots
can currently send video files of up to 50 MB in size, this limit may be changed
in the future.
As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1
minute long. Use this method to send video messages. On success, the sent
Message is returned.
Use this method to send audio files, if you want Telegram clients to display the
file as a playable voice message. For this to work, your audio must be in an
.ogg file encoded with OPUS (other formats may be sent as Audio or Document). On
success, the sent Message is returned. Bots can currently send voice messages of
up to 50 MB in size, this limit may be changed in the future.
Use this method to change the description of a supergroup or a channel. The bot
must be an administrator in the chat for this to work and must have the
appropriate admin rights. Returns True on success.
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 admin rights. Returns True on success.
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
admin 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.
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 admin rights. Returns True on success.
Use this method to set the score of the specified user in a game. On success, if
the message was sent by the bot, returns the edited Message, otherwise returns
True. Returns an error, if the new score is not greater than the user’s current
score in the chat and force is False.
Use this method to specify a url and receive incoming updates via an outgoing
webhook. Whenever there is an update for the bot, we will send an HTTPS POST
request to the specified url, containing a JSON-serialized Update. In case of an
unsuccessful request, we will give up after a reasonable amount of attempts.
Returns True on success.
Use this method to stop updating a live location message before live_period
expires. On success, if the message was sent by the bot, the sent Message is
returned, otherwise True is returned.
Use this method to unban a previously kicked user in a supergroup or channel.
The user will not return to the group or channel automatically, but will be able
to join via link, etc. The bot must be an administrator for this to work.
Returns True on success.
Use this method to unpin a message in a group, a supergroup, or a channel. The
bot must be an administrator in the chat for this to work and must have the
‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin
right in the channel. Returns True on success.
Use this method to upload a .png file with a sticker for later use in
createNewStickerSet and addStickerToSet methods (can be used multiple times).
Returns the uploaded File on success.