objects
the bot api objects, unions and enums (bot api 10.0).
AcceptedGiftTypes
This object describes the types of gifts that can be gifted to a user or a chat.
| field | type | required | description |
|---|---|---|---|
unlimited_gifts | boolean | ✓ | True, if unlimited regular gifts are accepted |
limited_gifts | boolean | ✓ | True, if limited regular gifts are accepted |
unique_gifts | boolean | ✓ | True, if unique gifts or gifts that can be upgraded to unique for free are accepted |
premium_subscription | boolean | ✓ | True, if a Telegram Premium subscription is accepted |
gifts_from_channels | boolean | ✓ | True, if transfers of unique gifts from channels are accepted |
AffiliateInfo
Contains information about the affiliate that received a commission via this transaction.
| field | type | required | description |
|---|---|---|---|
affiliate_user | User | Optional. The bot or the user that received an affiliate commission if it was received by a bot or a user | |
affiliate_chat | Chat | Optional. The chat that received an affiliate commission if it was received by a chat | |
commission_per_mille | integer | ✓ | The number of Telegram Stars received by the affiliate for each 1000 Telegram Stars received by the bot from referred users |
amount | integer | ✓ | Integer amount of Telegram Stars received by the affiliate from the transaction, rounded to 0; can be negative for refunds |
nanostar_amount | integer | Optional. The number of 1/1000000000 shares of Telegram Stars received by the affiliate; from -999999999 to 999999999; can be negative for refunds |
Animation
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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. |
width | integer | ✓ | Video width as defined by the sender |
height | integer | ✓ | Video height as defined by the sender |
duration | integer | ✓ | Duration of the video in seconds as defined by the sender |
thumbnail | PhotoSize | Optional. Animation thumbnail as defined by the sender | |
file_name | string | Optional. Original animation filename as defined by the sender | |
mime_type | string | Optional. MIME type of the file as defined by the sender | |
file_size | integer | Optional. 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.
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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. |
duration | integer | ✓ | Duration of the audio in seconds as defined by the sender |
performer | string | Optional. Performer of the audio as defined by the sender or by audio tags | |
title | string | Optional. Title of the audio as defined by the sender or by audio tags | |
file_name | string | Optional. Original filename as defined by the sender | |
mime_type | string | Optional. MIME type of the file as defined by the sender | |
file_size | integer | Optional. 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. | |
thumbnail | PhotoSize | Optional. Thumbnail of the album cover to which the music file belongs |
BackgroundFill
This object describes the way a background is filled based on the selected colors. Currently, it can be one of
one of: BackgroundFillSolid, BackgroundFillGradient, BackgroundFillFreeformGradient
BackgroundFillFreeformGradient
The background is a freeform gradient that rotates after every message in the chat.
| field | type | required | description |
|---|---|---|---|
type | freeform_gradient | ✓ | Type of the background fill, always “freeform_gradient” |
colors | integer[] | ✓ | A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format |
BackgroundFillGradient
The background is a gradient fill.
| field | type | required | description |
|---|---|---|---|
type | gradient | ✓ | Type of the background fill, always “gradient” |
top_color | integer | ✓ | Top color of the gradient in the RGB24 format |
bottom_color | integer | ✓ | Bottom color of the gradient in the RGB24 format |
rotation_angle | integer | ✓ | Clockwise rotation angle of the background fill in degrees; 0-359 |
BackgroundFillSolid
The background is filled using the selected color.
| field | type | required | description |
|---|---|---|---|
type | solid | ✓ | Type of the background fill, always “solid” |
color | integer | ✓ | The color of the background fill in the RGB24 format |
BackgroundType
This object describes the type of a background. Currently, it can be one of
one of: BackgroundTypeFill, BackgroundTypeWallpaper, BackgroundTypePattern, BackgroundTypeChatTheme
BackgroundTypeChatTheme
The background is taken directly from a built-in chat theme.
| field | type | required | description |
|---|---|---|---|
type | chat_theme | ✓ | Type of the background, always “chat_theme” |
theme_name | string | ✓ | Name of the chat theme, which is usually an emoji |
BackgroundTypeFill
The background is automatically filled based on the selected colors.
| field | type | required | description |
|---|---|---|---|
type | fill | ✓ | Type of the background, always “fill” |
fill | BackgroundFill | ✓ | The background fill |
dark_theme_dimming | integer | ✓ | Dimming of the background in dark themes, as a percentage; 0-100 |
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.
| field | type | required | description |
|---|---|---|---|
type | pattern | ✓ | Type of the background, always “pattern” |
document | Document | ✓ | Document with the pattern |
fill | BackgroundFill | ✓ | The background fill that is combined with the pattern |
intensity | integer | ✓ | Intensity of the pattern when it is shown above the filled background; 0-100 |
is_inverted | true | Optional. 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_moving | true | Optional. True, if the background moves slightly when the device is tilted |
BackgroundTypeWallpaper
The background is a wallpaper in the JPEG format.
| field | type | required | description |
|---|---|---|---|
type | wallpaper | ✓ | Type of the background, always “wallpaper” |
document | Document | ✓ | Document with the wallpaper |
dark_theme_dimming | integer | ✓ | Dimming of the background in dark themes, as a percentage; 0-100 |
is_blurred | true | Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12 | |
is_moving | true | Optional. True, if the background moves slightly when the device is tilted |
Birthdate
Describes the birthdate of a user.
| field | type | required | description |
|---|---|---|---|
day | integer | ✓ | Day of the user's birth; 1-31 |
month | integer | ✓ | Month of the user's birth; 1-12 |
year | integer | Optional. Year of the user's birth |
BotAccessSettings
This object describes the access settings of a bot.
| field | type | required | description |
|---|---|---|---|
is_access_restricted | boolean | ✓ | True, if only selected users can access the bot. The bot's owner can always access it. |
added_users | User[] | Optional. The list of other users who have access to the bot if the access is restricted |
BotCommand
This object represents a bot command.
| field | type | required | description |
|---|---|---|---|
command | string | ✓ | Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores. |
description | string | ✓ | Description 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:
BotCommandScopeAllChatAdministrators
Represents the scope of bot commands, covering all group and supergroup chat administrators.
| field | type | required | description |
|---|---|---|---|
type | all_chat_administrators | ✓ | Scope type, must be all_chat_administrators |
BotCommandScopeAllGroupChats
Represents the scope of bot commands, covering all group and supergroup chats.
| field | type | required | description |
|---|---|---|---|
type | all_group_chats | ✓ | Scope type, must be all_group_chats |
BotCommandScopeAllPrivateChats
Represents the scope of bot commands, covering all private chats.
| field | type | required | description |
|---|---|---|---|
type | all_private_chats | ✓ | Scope type, must be all_private_chats |
BotCommandScopeChat
Represents the scope of bot commands, covering a specific chat.
| field | type | required | description |
|---|---|---|---|
type | chat | ✓ | Scope type, must be chat |
chat_id | integer | string | ✓ | Unique 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.
| field | type | required | description |
|---|---|---|---|
type | chat_administrators | ✓ | Scope type, must be chat_administrators |
chat_id | integer | string | ✓ | Unique 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.
| field | type | required | description |
|---|---|---|---|
type | chat_member | ✓ | Scope type, must be chat_member |
chat_id | integer | string | ✓ | Unique 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_id | integer | ✓ | Unique identifier of the target user |
BotCommandScopeDefault
Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.
| field | type | required | description |
|---|---|---|---|
type | default | ✓ | Scope type, must be default |
BotDescription
This object represents the bot's description.
| field | type | required | description |
|---|---|---|---|
description | string | ✓ | The bot's description |
BotName
This object represents the bot's name.
| field | type | required | description |
|---|---|---|---|
name | string | ✓ | The bot's name |
BotShortDescription
This object represents the bot's short description.
| field | type | required | description |
|---|---|---|---|
short_description | string | ✓ | The bot's short description |
BusinessBotRights
Represents the rights of a business bot.
| field | type | required | description |
|---|---|---|---|
can_reply | true | Optional. True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours | |
can_read_messages | true | Optional. True, if the bot can mark incoming private messages as read | |
can_delete_sent_messages | true | Optional. True, if the bot can delete messages sent by the bot | |
can_delete_all_messages | true | Optional. True, if the bot can delete all private messages in managed chats | |
can_edit_name | true | Optional. True, if the bot can edit the first and last name of the business account | |
can_edit_bio | true | Optional. True, if the bot can edit the bio of the business account | |
can_edit_profile_photo | true | Optional. True, if the bot can edit the profile photo of the business account | |
can_edit_username | true | Optional. True, if the bot can edit the username of the business account | |
can_change_gift_settings | true | Optional. True, if the bot can change the privacy settings pertaining to gifts for the business account | |
can_view_gifts_and_stars | true | Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account | |
can_convert_gifts_to_stars | true | Optional. True, if the bot can convert regular gifts owned by the business account to Telegram Stars | |
can_transfer_and_upgrade_gifts | true | Optional. True, if the bot can transfer and upgrade gifts owned by the business account | |
can_transfer_stars | true | Optional. 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_stories | true | Optional. 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.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Unique identifier of the business connection |
user | User | ✓ | Business account user that created the business connection |
user_chat_id | integer | ✓ | Identifier 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. |
date | integer | ✓ | Date the connection was established in Unix time |
rights | BusinessBotRights | Optional. Rights of the business bot | |
is_enabled | boolean | ✓ | True, if the connection is active |
BusinessIntro
Contains information about the start page settings of a Telegram Business account.
| field | type | required | description |
|---|---|---|---|
title | string | Optional. Title text of the business intro | |
message | string | Optional. Message text of the business intro | |
sticker | Sticker | Optional. Sticker of the business intro |
BusinessLocation
Contains information about the location of a Telegram Business account.
| field | type | required | description |
|---|---|---|---|
address | string | ✓ | Address of the business |
location | Location | Optional. Location of the business |
BusinessMessagesDeleted
This object is received when messages are deleted from a connected business account.
| field | type | required | description |
|---|---|---|---|
business_connection_id | string | ✓ | Unique identifier of the business connection |
chat | Chat | ✓ | Information about a chat in the business account. The bot may not have access to the chat or the corresponding user. |
message_ids | integer[] | ✓ | The list of identifiers of deleted messages in the chat of the business account |
BusinessOpeningHours
Describes the opening hours of a business.
| field | type | required | description |
|---|---|---|---|
time_zone_name | string | ✓ | Unique name of the time zone for which the opening hours are defined |
opening_hours | BusinessOpeningHoursInterval[] | ✓ | List of time intervals describing business opening hours |
BusinessOpeningHoursInterval
Describes an interval of time during which a business is open.
| field | type | required | description |
|---|---|---|---|
opening_minute | integer | ✓ | The 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_minute | integer | ✓ | The 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 |
CallbackGame
A placeholder, currently holds no information. Use BotFather to set up your game.
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.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Unique identifier for this query |
from | User | ✓ | Sender |
message | MaybeInaccessibleMessage | Optional. Message sent by the bot with the callback button that originated the query | |
inline_message_id | string | Optional. Identifier of the message sent via the bot in inline mode, that originated the query | |
chat_instance | string | ✓ | Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. |
data | string | Optional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data. | |
game_short_name | string | Optional. Short name of a Game to be returned, serves as the unique identifier for the game |
Chat
This object represents a chat.
| field | type | required | description |
|---|---|---|---|
id | integer | ✓ | Unique 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. |
type | private | group | supergroup | channel | ✓ | Type of the chat, can be either “private”, “group”, “supergroup” or “channel” |
title | string | Optional. Title, for supergroups, channels and group chats | |
username | string | Optional. Username, for private chats, supergroups and channels if available | |
first_name | string | Optional. First name of the other party in a private chat | |
last_name | string | Optional. Last name of the other party in a private chat | |
is_forum | true | Optional. True, if the supergroup chat is a forum (has topics enabled) | |
is_direct_messages | true | Optional. True, if the chat is the direct messages chat of a channel |
ChatAdministratorRights
Represents the rights of an administrator in a chat.
| field | type | required | description |
|---|---|---|---|
is_anonymous | boolean | ✓ | True, if the user's presence in the chat is hidden |
can_manage_chat | boolean | ✓ | 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_messages | boolean | ✓ | True, if the administrator can delete messages of other users |
can_manage_video_chats | boolean | ✓ | True, if the administrator can manage video chats |
can_restrict_members | boolean | ✓ | True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics |
can_promote_members | boolean | ✓ | 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 the user) |
can_change_info | boolean | ✓ | True, if the user is allowed to change the chat title, photo and other settings |
can_invite_users | boolean | ✓ | True, if the user is allowed to invite new users to the chat |
can_post_stories | boolean | ✓ | True, if the administrator can post stories to the chat |
can_edit_stories | boolean | ✓ | 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_stories | boolean | ✓ | True, if the administrator can delete stories posted by other users |
can_post_messages | boolean | Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | |
can_edit_messages | boolean | Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only | |
can_pin_messages | boolean | Optional. True, if the user is allowed to pin messages; for groups and supergroups only | |
can_manage_topics | boolean | Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | |
can_manage_direct_messages | boolean | Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only | |
can_manage_tags | boolean | Optional. 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. |
ChatBackground
This object represents a chat background.
| field | type | required | description |
|---|---|---|---|
type | BackgroundType | ✓ | Type of the background |
ChatBoost
This object contains information about a chat boost.
| field | type | required | description |
|---|---|---|---|
boost_id | string | ✓ | Unique identifier of the boost |
add_date | integer | ✓ | Point in time (Unix timestamp) when the chat was boosted |
expiration_date | integer | ✓ | Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged |
source | ChatBoostSource | ✓ | Source of the added boost |
ChatBoostAdded
This object represents a service message about a user boosting a chat.
| field | type | required | description |
|---|---|---|---|
boost_count | integer | ✓ | Number of boosts added by the user |
ChatBoostRemoved
This object represents a boost removed from a chat.
| field | type | required | description |
|---|---|---|---|
chat | Chat | ✓ | Chat which was boosted |
boost_id | string | ✓ | Unique identifier of the boost |
remove_date | integer | ✓ | Point in time (Unix timestamp) when the boost was removed |
source | ChatBoostSource | ✓ | Source of the removed boost |
ChatBoostSource
This object describes the source of a chat boost. It can be one of
one of: ChatBoostSourcePremium, ChatBoostSourceGiftCode, ChatBoostSourceGiveaway
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.
| field | type | required | description |
|---|---|---|---|
source | gift_code | ✓ | Source of the boost, always “gift_code” |
user | User | ✓ | User 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.
| field | type | required | description |
|---|---|---|---|
source | giveaway | ✓ | Source of the boost, always “giveaway” |
giveaway_message_id | integer | ✓ | Identifier 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. |
user | User | Optional. User that won the prize in the giveaway if any; for Telegram Premium giveaways only | |
prize_star_count | integer | Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | |
is_unclaimed | true | Optional. True, if the giveaway was completed, but there was no user to win the prize |
ChatBoostSourcePremium
The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.
| field | type | required | description |
|---|---|---|---|
source | premium | ✓ | Source of the boost, always “premium” |
user | User | ✓ | User that boosted the chat |
ChatBoostUpdated
This object represents a boost added to a chat or changed.
| field | type | required | description |
|---|---|---|---|
chat | Chat | ✓ | Chat which was boosted |
boost | ChatBoost | ✓ | Information about the chat boost |
ChatFullInfo
This object contains full information about a chat.
| field | type | required | description |
|---|---|---|---|
id | integer | ✓ | Unique 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. |
type | private | group | supergroup | channel | ✓ | Type of the chat, can be either “private”, “group”, “supergroup” or “channel” |
title | string | Optional. Title, for supergroups, channels and group chats | |
username | string | Optional. Username, for private chats, supergroups and channels if available | |
first_name | string | Optional. First name of the other party in a private chat | |
last_name | string | Optional. Last name of the other party in a private chat | |
is_forum | true | Optional. True, if the supergroup chat is a forum (has topics enabled) | |
is_direct_messages | true | Optional. True, if the chat is the direct messages chat of a channel | |
accent_color_id | integer | ✓ | Identifier 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_count | integer | ✓ | The maximum number of reactions that can be set on a message in the chat |
photo | ChatPhoto | Optional. Chat photo | |
active_usernames | string[] | Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels | |
birthdate | Birthdate | Optional. For private chats, the date of birth of the user | |
business_intro | BusinessIntro | Optional. For private chats with business accounts, the intro of the business | |
business_location | BusinessLocation | Optional. For private chats with business accounts, the location of the business | |
business_opening_hours | BusinessOpeningHours | Optional. For private chats with business accounts, the opening hours of the business | |
personal_chat | Chat | Optional. For private chats, the personal channel of the user | |
parent_chat | Chat | Optional. Information about the corresponding channel chat; for direct messages chats only | |
available_reactions | ReactionType[] | Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed. | |
background_custom_emoji_id | string | Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background | |
profile_accent_color_id | integer | Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details. | |
profile_background_custom_emoji_id | string | Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background | |
emoji_status_custom_emoji_id | string | Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat | |
emoji_status_expiration_date | integer | Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any | |
bio | string | Optional. Bio of the other party in a private chat | |
has_private_forwards | true | Optional. 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_messages | true | Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat | |
join_to_send_messages | true | Optional. True, if users need to join the supergroup before they can send messages | |
join_by_request | true | Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators | |
description | string | Optional. Description, for groups, supergroups and channel chats | |
invite_link | string | Optional. Primary invite link, for groups, supergroups and channel chats | |
pinned_message | Message | Optional. The most recent pinned message (by sending date) | |
permissions | ChatPermissions | Optional. Default chat member permissions, for groups and supergroups | |
accepted_gift_types | AcceptedGiftTypes | ✓ | Information about types of gifts that are accepted by the chat or by the corresponding user for private chats |
can_send_paid_media | true | Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only for channel chats. | |
slow_mode_delay | integer | Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds | |
unrestrict_boost_count | integer | Optional. 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_time | integer | Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds | |
has_aggressive_anti_spam_enabled | true | Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators. | |
has_hidden_members | true | Optional. True, if non-administrators can only get the list of bots and administrators in the chat | |
has_protected_content | true | Optional. True, if messages from the chat can't be forwarded to other chats | |
has_visible_history | true | Optional. True, if new chat members will have access to old messages; available only to chat administrators | |
sticker_set_name | string | Optional. For supergroups, name of the group sticker set | |
can_set_sticker_set | true | Optional. True, if the bot can change the group sticker set | |
custom_emoji_sticker_set_name | string | Optional. 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_id | integer | Optional. 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. | |
location | ChatLocation | Optional. For supergroups, the location to which the supergroup is connected | |
rating | UserRating | Optional. For private chats, the rating of the user if any | |
first_profile_audio | Audio | Optional. For private chats, the first audio added to the profile of the user | |
unique_gift_colors | UniqueGiftColors | Optional. 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_count | integer | Optional. The number of Telegram Stars a general user has to pay to send a message to the chat |
ChatInviteLink
Represents an invite link for a chat.
| field | type | required | description |
|---|---|---|---|
invite_link | string | ✓ | The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”. |
creator | User | ✓ | Creator of the link |
creates_join_request | boolean | ✓ | True, if users joining the chat via the link need to be approved by chat administrators |
is_primary | boolean | ✓ | True, if the link is primary |
is_revoked | boolean | ✓ | True, if the link is revoked |
name | string | Optional. Invite link name | |
expire_date | integer | Optional. Point in time (Unix timestamp) when the link will expire or has been expired | |
member_limit | integer | Optional. 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_count | integer | Optional. Number of pending join requests created using this link | |
subscription_period | integer | Optional. The number of seconds the subscription will be active for before the next payment | |
subscription_price | integer | Optional. 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 |
ChatJoinRequest
Represents a join request sent to a chat.
| field | type | required | description |
|---|---|---|---|
chat | Chat | ✓ | Chat to which the request was sent |
from | User | ✓ | User that sent the join request |
user_chat_id | integer | ✓ | Identifier 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. |
date | integer | ✓ | Date the request was sent in Unix time |
bio | string | Optional. Bio of the user | |
invite_link | ChatInviteLink | Optional. Chat invite link that was used by the user to send the join request |
ChatLocation
Represents a location to which a chat is connected.
| field | type | required | description |
|---|---|---|---|
location | Location | ✓ | The location to which the supergroup is connected. Can't be a live location. |
address | string | ✓ | Location address; 1-64 characters, as defined by the chat owner |
ChatMember
This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:
ChatMemberAdministrator
Represents a chat member that has some additional privileges.
| field | type | required | description |
|---|---|---|---|
status | administrator | ✓ | The member's status in the chat, always “administrator” |
user | User | ✓ | Information about the user |
can_be_edited | boolean | ✓ | True, if the bot is allowed to edit administrator privileges of that user |
is_anonymous | boolean | ✓ | True, if the user's presence in the chat is hidden |
can_manage_chat | boolean | ✓ | 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_messages | boolean | ✓ | True, if the administrator can delete messages of other users |
can_manage_video_chats | boolean | ✓ | True, if the administrator can manage video chats |
can_restrict_members | boolean | ✓ | True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics |
can_promote_members | boolean | ✓ | 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 the user) |
can_change_info | boolean | ✓ | True, if the user is allowed to change the chat title, photo and other settings |
can_invite_users | boolean | ✓ | True, if the user is allowed to invite new users to the chat |
can_post_stories | boolean | ✓ | True, if the administrator can post stories to the chat |
can_edit_stories | boolean | ✓ | 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_stories | boolean | ✓ | True, if the administrator can delete stories posted by other users |
can_post_messages | boolean | Optional. True, if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only | |
can_edit_messages | boolean | Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only | |
can_pin_messages | boolean | Optional. True, if the user is allowed to pin messages; for groups and supergroups only | |
can_manage_topics | boolean | Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only | |
can_manage_direct_messages | boolean | Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for channels only | |
can_manage_tags | boolean | Optional. 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_title | string | Optional. Custom title for this user |
ChatMemberBanned
Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
| field | type | required | description |
|---|---|---|---|
status | kicked | ✓ | The member's status in the chat, always “kicked” |
user | User | ✓ | Information about the user |
until_date | integer | ✓ | Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever. |
ChatMemberLeft
Represents a chat member that isn't currently a member of the chat, but may join it themselves.
| field | type | required | description |
|---|---|---|---|
status | left | ✓ | The member's status in the chat, always “left” |
user | User | ✓ | Information about the user |
ChatMemberMember
Represents a chat member that has no additional privileges or restrictions.
| field | type | required | description |
|---|---|---|---|
status | member | ✓ | The member's status in the chat, always “member” |
tag | string | Optional. Tag of the member | |
user | User | ✓ | Information about the user |
until_date | integer | Optional. Date when the user's subscription will expire; Unix time |
ChatMemberOwner
Represents a chat member that owns the chat and has all administrator privileges.
| field | type | required | description |
|---|---|---|---|
status | creator | ✓ | The member's status in the chat, always “creator” |
user | User | ✓ | Information about the user |
is_anonymous | boolean | ✓ | True, if the user's presence in the chat is hidden |
custom_title | string | Optional. Custom title for this user |
ChatMemberRestricted
Represents a chat member that is under certain restrictions in the chat. Supergroups only.
| field | type | required | description |
|---|---|---|---|
status | restricted | ✓ | The member's status in the chat, always “restricted” |
tag | string | Optional. Tag of the member | |
user | User | ✓ | Information about the user |
is_member | boolean | ✓ | True, if the user is a member of the chat at the moment of the request |
can_send_messages | boolean | ✓ | True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues |
can_send_audios | boolean | ✓ | True, if the user is allowed to send audios |
can_send_documents | boolean | ✓ | True, if the user is allowed to send documents |
can_send_photos | boolean | ✓ | True, if the user is allowed to send photos |
can_send_videos | boolean | ✓ | True, if the user is allowed to send videos |
can_send_video_notes | boolean | ✓ | True, if the user is allowed to send video notes |
can_send_voice_notes | boolean | ✓ | True, if the user is allowed to send voice notes |
can_send_polls | boolean | ✓ | True, if the user is allowed to send polls and checklists |
can_send_other_messages | boolean | ✓ | True, if the user is allowed to send animations, games, stickers and use inline bots |
can_add_web_page_previews | boolean | ✓ | True, if the user is allowed to add web page previews to their messages |
can_react_to_messages | boolean | ✓ | True, if the user is allowed to react to messages |
can_edit_tag | boolean | ✓ | True, if the user is allowed to edit their own tag |
can_change_info | boolean | ✓ | True, if the user is allowed to change the chat title, photo and other settings |
can_invite_users | boolean | ✓ | True, if the user is allowed to invite new users to the chat |
can_pin_messages | boolean | ✓ | True, if the user is allowed to pin messages |
can_manage_topics | boolean | ✓ | True, if the user is allowed to create forum topics |
until_date | integer | ✓ | Date when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever. |
ChatMemberUpdated
This object represents changes in the status of a chat member.
| field | type | required | description |
|---|---|---|---|
chat | Chat | ✓ | Chat the user belongs to |
from | User | ✓ | Performer of the action, which resulted in the change |
date | integer | ✓ | Date the change was done in Unix time |
old_chat_member | ChatMember | ✓ | Previous information about the chat member |
new_chat_member | ChatMember | ✓ | New information about the chat member |
invite_link | ChatInviteLink | Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only | |
via_join_request | boolean | Optional. 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_link | boolean | Optional. True, if the user joined the chat via a chat folder invite link |
ChatOwnerChanged
Describes a service message about an ownership change in the chat.
| field | type | required | description |
|---|---|---|---|
new_owner | User | ✓ | The new owner of the chat |
ChatOwnerLeft
Describes a service message about the chat owner leaving the chat.
| field | type | required | description |
|---|---|---|---|
new_owner | User | Optional. The user who will become the new owner of the chat if the previous owner does not return to the chat |
ChatPermissions
Describes actions that a non-administrator user is allowed to take in a chat.
| field | type | required | description |
|---|---|---|---|
can_send_messages | boolean | Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and venues | |
can_send_audios | boolean | Optional. True, if the user is allowed to send audios | |
can_send_documents | boolean | Optional. True, if the user is allowed to send documents | |
can_send_photos | boolean | Optional. True, if the user is allowed to send photos | |
can_send_videos | boolean | Optional. True, if the user is allowed to send videos | |
can_send_video_notes | boolean | Optional. True, if the user is allowed to send video notes | |
can_send_voice_notes | boolean | Optional. True, if the user is allowed to send voice notes | |
can_send_polls | boolean | Optional. True, if the user is allowed to send polls and checklists | |
can_send_other_messages | boolean | Optional. True, if the user is allowed to send animations, games, stickers and use inline bots | |
can_add_web_page_previews | boolean | Optional. True, if the user is allowed to add web page previews to their messages | |
can_react_to_messages | boolean | Optional. True, if the user is allowed to react to messages. If omitted, defaults to the value of can_send_messages. | |
can_edit_tag | boolean | Optional. True, if the user is allowed to edit their own tag. If omitted, defaults to the value of can_pin_messages. | |
can_change_info | boolean | Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups. | |
can_invite_users | boolean | Optional. True, if the user is allowed to invite new users to the chat | |
can_pin_messages | boolean | Optional. True, if the user is allowed to pin messages. Ignored in public supergroups. | |
can_manage_topics | boolean | Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages. |
ChatPhoto
This object represents a chat photo.
| field | type | required | description |
|---|---|---|---|
small_file_id | string | ✓ | File 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_id | string | ✓ | Unique 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_id | string | ✓ | File 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_id | string | ✓ | Unique 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. |
ChatShared
This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.
| field | type | required | description |
|---|---|---|---|
request_id | integer | ✓ | Identifier of the request |
chat_id | integer | ✓ | Identifier 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. |
title | string | Optional. Title of the chat, if the title was requested by the bot | |
username | string | Optional. Username of the chat, if the username was requested by the bot and available | |
photo | PhotoSize[] | Optional. Available sizes of the chat photo, if the photo was requested by the bot |
Checklist
Describes a checklist.
| field | type | required | description |
|---|---|---|---|
title | string | ✓ | Title of the checklist |
title_entities | MessageEntity[] | Optional. Special entities that appear in the checklist title | |
tasks | ChecklistTask[] | ✓ | List of tasks in the checklist |
others_can_add_tasks | true | Optional. True, if users other than the creator of the list can add tasks to the list | |
others_can_mark_tasks_as_done | true | Optional. True, if users other than the creator of the list can mark tasks as done or not done |
ChecklistTask
Describes a task in a checklist.
| field | type | required | description |
|---|---|---|---|
id | integer | ✓ | Unique identifier of the task |
text | string | ✓ | Text of the task |
text_entities | MessageEntity[] | Optional. Special entities that appear in the task text | |
completed_by_user | User | Optional. User that completed the task; omitted if the task wasn't completed by a user | |
completed_by_chat | Chat | Optional. Chat that completed the task; omitted if the task wasn't completed by a chat | |
completion_date | integer | Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed |
ChecklistTasksAdded
Describes a service message about tasks added to a checklist.
| field | type | required | description |
|---|---|---|---|
checklist_message | Message | Optional. 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. | |
tasks | ChecklistTask[] | ✓ | List of tasks added to the checklist |
ChecklistTasksDone
Describes a service message about checklist tasks marked as done or not done.
| field | type | required | description |
|---|---|---|---|
checklist_message | Message | Optional. 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_ids | integer[] | Optional. Identifiers of the tasks that were marked as done | |
marked_as_not_done_task_ids | integer[] | Optional. Identifiers of the tasks that were marked as not done |
ChosenInlineResult
Represents a result of an inline query that was chosen by the user and sent to their chat partner.
| field | type | required | description |
|---|---|---|---|
result_id | string | ✓ | The unique identifier for the result that was chosen |
from | User | ✓ | The user that chose the result |
location | Location | Optional. Sender location, only for bots that require user location | |
inline_message_id | string | Optional. 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. | |
query | string | ✓ | The query that was used to obtain the result |
Contact
This object represents a phone contact.
| field | type | required | description |
|---|---|---|---|
phone_number | string | ✓ | Contact's phone number |
first_name | string | ✓ | Contact's first name |
last_name | string | Optional. Contact's last name | |
user_id | integer | Optional. Contact's user identifier in Telegram. This 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. | |
vcard | string | Optional. Additional data about the contact in the form of a vCard |
CopyTextButton
This object represents an inline keyboard button that copies specified text to the clipboard.
| field | type | required | description |
|---|---|---|---|
text | string | ✓ | The text to be copied to the clipboard; 1-256 characters |
Dice
This object represents an animated emoji that displays a random value.
| field | type | required | description |
|---|---|---|---|
emoji | string | ✓ | Emoji on which the dice throw animation is based |
value | integer | ✓ | Value of the dice, 1-6 for “”, “” and “” base emoji, 1-5 for “” and “” base emoji, 1-64 for “” base emoji |
DirectMessagePriceChanged
Describes a service message about a change in the price of direct messages sent to a channel chat.
| field | type | required | description |
|---|---|---|---|
are_direct_messages_enabled | boolean | ✓ | True, if direct messages are enabled for the channel chat; false otherwise |
direct_message_star_count | integer | Optional. 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. |
DirectMessagesTopic
Describes a topic of a direct messages chat.
| field | type | required | description |
|---|---|---|---|
topic_id | integer | ✓ | Unique 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. |
user | User | Optional. Information about the user that created the topic. Currently, it is always present. |
Document
This object represents a general file (as opposed to photos, voice messages and audio files).
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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. |
thumbnail | PhotoSize | Optional. Document thumbnail as defined by the sender | |
file_name | string | Optional. Original filename as defined by the sender | |
mime_type | string | Optional. MIME type of the file as defined by the sender | |
file_size | integer | Optional. 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. |
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.
| field | type | required | description |
|---|---|---|---|
data | string | ✓ | Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication |
hash | string | ✓ | Base64-encoded data hash for data authentication |
secret | string | ✓ | Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption |
EncryptedPassportElement
Describes documents or other Telegram Passport elements shared with the bot by the user.
| field | type | required | description |
|---|---|---|---|
type | personal_details | passport | driver_license | identity_card | internal_passport | address | utility_bill | bank_statement | rental_agreement | passport_registration | temporary_registration | phone_number | email | ✓ | Element 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”. |
data | string | Optional. 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_number | string | Optional. User's verified phone number; available only for “phone_number” type | |
email | string | Optional. User's verified email address; available only for “email” type | |
files | PassportFile[] | Optional. 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_side | PassportFile | Optional. 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_side | PassportFile | Optional. 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. | |
selfie | PassportFile | Optional. 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. | |
translation | PassportFile[] | Optional. 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. | |
hash | string | ✓ | Base64-encoded element hash for using in PassportElementErrorUnspecified |
ExternalReplyInfo
This object contains information about a message that is being replied to, which may come from another chat or forum topic.
| field | type | required | description |
|---|---|---|---|
origin | MessageOrigin | ✓ | Origin of the message replied to by the given message |
chat | Chat | Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel. | |
message_id | integer | Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel. | |
link_preview_options | LinkPreviewOptions | Optional. Options used for link preview generation for the original message, if it is a text message | |
animation | Animation | Optional. Message is an animation, information about the animation | |
audio | Audio | Optional. Message is an audio file, information about the file | |
document | Document | Optional. Message is a general file, information about the file | |
live_photo | LivePhoto | Optional. Message is a live photo, information about the live photo | |
paid_media | PaidMediaInfo | Optional. Message contains paid media; information about the paid media | |
photo | PhotoSize[] | Optional. Message is a photo, available sizes of the photo | |
sticker | Sticker | Optional. Message is a sticker, information about the sticker | |
story | Story | Optional. Message is a forwarded story | |
video | Video | Optional. Message is a video, information about the video | |
video_note | VideoNote | Optional. Message is a video note, information about the video message | |
voice | Voice | Optional. Message is a voice message, information about the file | |
has_media_spoiler | true | Optional. True, if the message media is covered by a spoiler animation | |
checklist | Checklist | Optional. Message is a checklist | |
contact | Contact | Optional. Message is a shared contact, information about the contact | |
dice | Dice | Optional. Message is a dice with random value | |
game | Game | Optional. Message is a game, information about the game. More about games » | |
giveaway | Giveaway | Optional. Message is a scheduled giveaway, information about the giveaway | |
giveaway_winners | GiveawayWinners | Optional. A giveaway with public winners was completed | |
invoice | Invoice | Optional. Message is an invoice for a payment, information about the invoice. More about payments » | |
location | Location | Optional. Message is a shared location, information about the location | |
poll | Poll | Optional. Message is a native poll, information about the poll | |
venue | Venue | Optional. Message is a venue, information about the venue |
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.
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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_size | integer | Optional. 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_path | string | Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file. |
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.
| field | type | required | description |
|---|---|---|---|
force_reply | true | ✓ | Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply' |
input_field_placeholder | string | Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters | |
selective | boolean | Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message. |
ForumTopic
This object represents a forum topic.
| field | type | required | description |
|---|---|---|---|
message_thread_id | integer | ✓ | Unique identifier of the forum topic |
name | string | ✓ | Name of the topic |
icon_color | integer | ✓ | Color of the topic icon in RGB format |
icon_custom_emoji_id | string | Optional. Unique identifier of the custom emoji shown as the topic icon | |
is_name_implicit | true | Optional. 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.
ForumTopicCreated
This object represents a service message about a new forum topic created in the chat.
| field | type | required | description |
|---|---|---|---|
name | string | ✓ | Name of the topic |
icon_color | integer | ✓ | Color of the topic icon in RGB format |
icon_custom_emoji_id | string | Optional. Unique identifier of the custom emoji shown as the topic icon | |
is_name_implicit | true | Optional. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed by the bot |
ForumTopicEdited
This object represents a service message about an edited forum topic.
| field | type | required | description |
|---|---|---|---|
name | string | Optional. New name of the topic, if it was edited | |
icon_custom_emoji_id | string | Optional. 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.
Game
This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
| field | type | required | description |
|---|---|---|---|
title | string | ✓ | Title of the game |
description | string | ✓ | Description of the game |
photo | PhotoSize[] | ✓ | Photo that will be displayed in the game message in chats |
text | string | Optional. 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_entities | MessageEntity[] | Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. | |
animation | Animation | Optional. Animation that will be displayed in the game message in chats. Upload via BotFather. |
GameHighScore
This object represents one row of the high scores table for a game.
| field | type | required | description |
|---|---|---|---|
position | integer | ✓ | Position in high score table for the game |
user | User | ✓ | User |
score | integer | ✓ | Score |
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.
Gift
This object represents a gift that can be sent by the bot.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Unique identifier of the gift |
sticker | Sticker | ✓ | The sticker that represents the gift |
star_count | integer | ✓ | The number of Telegram Stars that must be paid to send the sticker |
upgrade_star_count | integer | Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one | |
is_premium | true | Optional. True, if the gift can only be purchased by Telegram Premium subscribers | |
has_colors | true | Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance | |
total_count | integer | Optional. The total number of gifts of this type that can be sent by all users; for limited gifts only | |
remaining_count | integer | Optional. The number of remaining gifts of this type that can be sent by all users; for limited gifts only | |
personal_total_count | integer | Optional. The total number of gifts of this type that can be sent by the bot; for limited gifts only | |
personal_remaining_count | integer | Optional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only | |
background | GiftBackground | Optional. Background of the gift | |
unique_gift_variant_count | integer | Optional. The total number of different unique gifts that can be obtained by upgrading the gift | |
publisher_chat | Chat | Optional. Information about the chat that published the gift |
GiftBackground
This object describes the background of a gift.
| field | type | required | description |
|---|---|---|---|
center_color | integer | ✓ | Center color of the background in RGB format |
edge_color | integer | ✓ | Edge color of the background in RGB format |
text_color | integer | ✓ | Text color of the background in RGB format |
GiftInfo
Describes a service message about a regular gift that was sent or received.
| field | type | required | description |
|---|---|---|---|
gift | Gift | ✓ | Information about the gift |
owned_gift_id | string | Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts | |
convert_star_count | integer | Optional. 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_count | integer | Optional. Number of Telegram Stars that were prepaid for the ability to upgrade the gift | |
is_upgrade_separate | true | Optional. True, if the gift's upgrade was purchased after the gift was sent | |
can_be_upgraded | true | Optional. True, if the gift can be upgraded to a unique gift | |
text | string | Optional. Text of the message that was added to the gift | |
entities | MessageEntity[] | Optional. Special entities that appear in the text | |
is_private | true | Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them | |
unique_gift_number | integer | Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift. |
Gifts
This object represent a list of gifts.
| field | type | required | description |
|---|---|---|---|
gifts | Gift[] | ✓ | The list of gifts |
Giveaway
This object represents a message about a scheduled giveaway.
| field | type | required | description |
|---|---|---|---|
chats | Chat[] | ✓ | The list of chats which the user must join to participate in the giveaway |
winners_selection_date | integer | ✓ | Point in time (Unix timestamp) when winners of the giveaway will be selected |
winner_count | integer | ✓ | The number of users which are supposed to be selected as winners of the giveaway |
only_new_members | true | Optional. True, if only users who join the chats after the giveaway started should be eligible to win | |
has_public_winners | true | Optional. True, if the list of giveaway winners will be visible to everyone | |
prize_description | string | Optional. Description of additional giveaway prize | |
country_codes | string[] | Optional. 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_count | integer | Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only | |
premium_subscription_month_count | integer | Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only |
GiveawayCompleted
This object represents a service message about the completion of a giveaway without public winners.
| field | type | required | description |
|---|---|---|---|
winner_count | integer | ✓ | Number of winners in the giveaway |
unclaimed_prize_count | integer | Optional. Number of undistributed prizes | |
giveaway_message | Message | Optional. Message with the giveaway that was completed, if it wasn't deleted | |
is_star_giveaway | true | Optional. True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway. |
GiveawayCreated
This object represents a service message about the creation of a scheduled giveaway.
| field | type | required | description |
|---|---|---|---|
prize_star_count | integer | Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only |
GiveawayWinners
This object represents a message about the completion of a giveaway with public winners.
| field | type | required | description |
|---|---|---|---|
chat | Chat | ✓ | The chat that created the giveaway |
giveaway_message_id | integer | ✓ | Identifier of the message with the giveaway in the chat |
winners_selection_date | integer | ✓ | Point in time (Unix timestamp) when winners of the giveaway were selected |
winner_count | integer | ✓ | Total number of winners in the giveaway |
winners | User[] | ✓ | List of up to 100 winners of the giveaway |
additional_chat_count | integer | Optional. The number of other chats the user had to join in order to be eligible for the giveaway | |
prize_star_count | integer | Optional. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only | |
premium_subscription_month_count | integer | Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only | |
unclaimed_prize_count | integer | Optional. Number of undistributed prizes | |
only_new_members | true | Optional. True, if only users who had joined the chats after the giveaway started were eligible to win | |
was_refunded | true | Optional. True, if the giveaway was canceled because the payment for it was refunded | |
prize_description | string | Optional. Description of additional giveaway prize |
InaccessibleMessage
This object describes a message that was deleted or is otherwise inaccessible to the bot.
| field | type | required | description |
|---|---|---|---|
chat | Chat | ✓ | Chat the message belonged to |
message_id | integer | ✓ | Unique message identifier inside the chat |
date | integer | ✓ | Always 0. The field can be used to differentiate regular and inaccessible messages. |
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.
| field | type | required | description |
|---|---|---|---|
text | string | ✓ | Label text on the button |
icon_custom_emoji_id | string | Optional. 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. | |
style | danger | success | primary | Optional. Style of the button. Must be one of “danger” (red), “success” (green) or “primary” (blue). If omitted, then an app-specific style is used. | |
url | string | Optional. 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_data | string | Optional. Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes | |
web_app | WebAppInfo | Optional. 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_url | LoginUrl | Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget. | |
switch_inline_query | string | Optional. 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_chat | string | Optional. 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_chat | SwitchInlineQueryChosenChat | Optional. 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_text | CopyTextButton | Optional. Description of the button that copies the specified text to the clipboard | |
callback_game | CallbackGame | Optional. 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. | |
pay | boolean | Optional. 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. |
InlineKeyboardMarkup
This object represents an inline keyboard that appears right next to the message it belongs to.
| field | type | required | description |
|---|---|---|---|
inline_keyboard | InlineKeyboardButton[][] | ✓ | Array of button rows, each represented by an Array of InlineKeyboardButton objects |
InlineQuery
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Unique identifier for this query |
from | User | ✓ | Sender |
query | string | ✓ | Text of the query (up to 256 characters) |
offset | string | ✓ | Offset of the results to be returned, can be controlled by the bot |
chat_type | sender | private | group | supergroup | channel | Optional. 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. | |
location | Location | Optional. Sender location, only for bots that request user location |
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.
one of: InlineQueryResultCachedAudio, InlineQueryResultCachedDocument, InlineQueryResultCachedGif, InlineQueryResultCachedMpeg4Gif, InlineQueryResultCachedPhoto, InlineQueryResultCachedSticker, InlineQueryResultCachedVideo, InlineQueryResultCachedVoice, InlineQueryResultArticle, InlineQueryResultAudio, InlineQueryResultContact, InlineQueryResultGame, InlineQueryResultDocument, InlineQueryResultGif, InlineQueryResultLocation, InlineQueryResultMpeg4Gif, InlineQueryResultPhoto, InlineQueryResultVenue, InlineQueryResultVideo, InlineQueryResultVoice
InlineQueryResultArticle
Represents a link to an article or web page.
| field | type | required | description |
|---|---|---|---|
type | article | ✓ | Type of the result, must be article |
id | string | ✓ | Unique identifier for this result, 1-64 Bytes |
title | string | ✓ | Title of the result |
input_message_content | InputMessageContent | ✓ | Content of the message to be sent |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
url | string | Optional. URL of the result | |
description | string | Optional. Short description of the result | |
thumbnail_url | string | Optional. Url of the thumbnail for the result | |
thumbnail_width | integer | Optional. Thumbnail width | |
thumbnail_height | integer | Optional. Thumbnail height |
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.
| field | type | required | description |
|---|---|---|---|
type | audio | ✓ | Type of the result, must be audio |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
audio_url | string | ✓ | A valid URL for the audio file |
title | string | ✓ | Title |
caption | string | Optional. Caption, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the audio caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
performer | string | Optional. Performer | |
audio_duration | integer | Optional. Audio duration in seconds | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the audio |
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.
| field | type | required | description |
|---|---|---|---|
type | audio | ✓ | Type of the result, must be audio |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
audio_file_id | string | ✓ | A valid file identifier for the audio file |
caption | string | Optional. Caption, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the audio caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the audio |
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.
| field | type | required | description |
|---|---|---|---|
type | document | ✓ | Type of the result, must be document |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
title | string | ✓ | Title for the result |
document_file_id | string | ✓ | A valid file identifier for the file |
description | string | Optional. Short description of the result | |
caption | string | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the document caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the file |
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.
| field | type | required | description |
|---|---|---|---|
type | gif | ✓ | Type of the result, must be gif |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
gif_file_id | string | ✓ | A valid file identifier for the GIF file |
title | string | Optional. Title for the result | |
caption | string | Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. 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.
| field | type | required | description |
|---|---|---|---|
type | mpeg4_gif | ✓ | Type of the result, must be mpeg4_gif |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
mpeg4_file_id | string | ✓ | A valid file identifier for the MPEG4 file |
title | string | Optional. Title for the result | |
caption | string | Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the video animation |
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.
| field | type | required | description |
|---|---|---|---|
type | photo | ✓ | Type of the result, must be photo |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
photo_file_id | string | ✓ | A valid file identifier of the photo |
title | string | Optional. Title for the result | |
description | string | Optional. Short description of the result | |
caption | string | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the photo caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the photo |
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.
| field | type | required | description |
|---|---|---|---|
type | sticker | ✓ | Type of the result, must be sticker |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
sticker_file_id | string | ✓ | A valid file identifier of the sticker |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the sticker |
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.
| field | type | required | description |
|---|---|---|---|
type | video | ✓ | Type of the result, must be video |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
video_file_id | string | ✓ | A valid file identifier for the video file |
title | string | ✓ | Title for the result |
description | string | Optional. Short description of the result | |
caption | string | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the video caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. 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.
| field | type | required | description |
|---|---|---|---|
type | voice | ✓ | Type of the result, must be voice |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
voice_file_id | string | ✓ | A valid file identifier for the voice message |
title | string | ✓ | Voice message title |
caption | string | Optional. Caption, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the voice message caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the voice message |
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.
| field | type | required | description |
|---|---|---|---|
type | contact | ✓ | Type of the result, must be contact |
id | string | ✓ | Unique identifier for this result, 1-64 Bytes |
phone_number | string | ✓ | Contact's phone number |
first_name | string | ✓ | Contact's first name |
last_name | string | Optional. Contact's last name | |
vcard | string | Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the contact | |
thumbnail_url | string | Optional. Url of the thumbnail for the result | |
thumbnail_width | integer | Optional. Thumbnail width | |
thumbnail_height | integer | Optional. Thumbnail height |
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.
| field | type | required | description |
|---|---|---|---|
type | document | ✓ | Type of the result, must be document |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
title | string | ✓ | Title for the result |
caption | string | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the document caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
document_url | string | ✓ | A valid URL for the file |
mime_type | application/pdf | application/zip | ✓ | MIME type of the content of the file, either “application/pdf” or “application/zip” |
description | string | Optional. Short description of the result | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the file | |
thumbnail_url | string | Optional. URL of the thumbnail (JPEG only) for the file | |
thumbnail_width | integer | Optional. Thumbnail width | |
thumbnail_height | integer | Optional. Thumbnail height |
InlineQueryResultGame
Represents a Game.
| field | type | required | description |
|---|---|---|---|
type | game | ✓ | Type of the result, must be game |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
game_short_name | string | ✓ | Short name of the game |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message |
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.
| field | type | required | description |
|---|---|---|---|
type | gif | ✓ | Type of the result, must be gif |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
gif_url | string | ✓ | A valid URL for the GIF file |
gif_width | integer | Optional. Width of the GIF | |
gif_height | integer | Optional. Height of the GIF | |
gif_duration | integer | Optional. Duration of the GIF in seconds | |
thumbnail_url | string | ✓ | URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result |
thumbnail_mime_type | image/jpeg | image/gif | video/mp4 | Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”. | |
title | string | Optional. Title for the result | |
caption | string | Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the GIF animation |
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.
| field | type | required | description |
|---|---|---|---|
type | location | ✓ | Type of the result, must be location |
id | string | ✓ | Unique identifier for this result, 1-64 Bytes |
latitude | float | ✓ | Location latitude in degrees |
longitude | float | ✓ | Location longitude in degrees |
title | string | ✓ | Location title |
horizontal_accuracy | float | Optional. The radius of uncertainty for the location, measured in meters; 0-1500 | |
live_period | integer | Optional. 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 | |
heading | integer | Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | |
proximity_alert_radius | integer | Optional. 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_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the location | |
thumbnail_url | string | Optional. Url of the thumbnail for the result | |
thumbnail_width | integer | Optional. Thumbnail width | |
thumbnail_height | integer | Optional. Thumbnail height |
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.
| field | type | required | description |
|---|---|---|---|
type | mpeg4_gif | ✓ | Type of the result, must be mpeg4_gif |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
mpeg4_url | string | ✓ | A valid URL for the MPEG4 file |
mpeg4_width | integer | Optional. Video width | |
mpeg4_height | integer | Optional. Video height | |
mpeg4_duration | integer | Optional. Video duration in seconds | |
thumbnail_url | string | ✓ | URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result |
thumbnail_mime_type | image/jpeg | image/gif | video/mp4 | Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”. | |
title | string | Optional. Title for the result | |
caption | string | Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the video animation |
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.
| field | type | required | description |
|---|---|---|---|
type | photo | ✓ | Type of the result, must be photo |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
photo_url | string | ✓ | A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB. |
thumbnail_url | string | ✓ | URL of the thumbnail for the photo |
photo_width | integer | Optional. Width of the photo | |
photo_height | integer | Optional. Height of the photo | |
title | string | Optional. Title for the result | |
description | string | Optional. Short description of the result | |
caption | string | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the photo caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the photo |
InlineQueryResultsButton
This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.
| field | type | required | description |
|---|---|---|---|
text | string | ✓ | Label text on the button |
web_app | WebAppInfo | Optional. 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_parameter | string | Optional. 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. |
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.
| field | type | required | description |
|---|---|---|---|
type | venue | ✓ | Type of the result, must be venue |
id | string | ✓ | Unique identifier for this result, 1-64 Bytes |
latitude | float | ✓ | Latitude of the venue location in degrees |
longitude | float | ✓ | Longitude of the venue location in degrees |
title | string | ✓ | Title of the venue |
address | string | ✓ | Address of the venue |
foursquare_id | string | Optional. Foursquare identifier of the venue if known | |
foursquare_type | string | Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) | |
google_place_id | string | Optional. Google Places identifier of the venue | |
google_place_type | string | Optional. Google Places type of the venue. (See supported types.) | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the venue | |
thumbnail_url | string | Optional. Url of the thumbnail for the result | |
thumbnail_width | integer | Optional. Thumbnail width | |
thumbnail_height | integer | Optional. Thumbnail height |
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.
| field | type | required | description |
|---|---|---|---|
type | video | ✓ | Type of the result, must be video |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
video_url | string | ✓ | A valid URL for the embedded video player or video file |
mime_type | string | ✓ | MIME type of the content of the video URL, “text/html” or “video/mp4” |
thumbnail_url | string | ✓ | URL of the thumbnail (JPEG only) for the video |
title | string | ✓ | Title for the result |
caption | string | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the video caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
video_width | integer | Optional. Video width | |
video_height | integer | Optional. Video height | |
video_duration | integer | Optional. Video duration in seconds | |
description | string | Optional. Short description of the result | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. 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). |
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.
| field | type | required | description |
|---|---|---|---|
type | voice | ✓ | Type of the result, must be voice |
id | string | ✓ | Unique identifier for this result, 1-64 bytes |
voice_url | string | ✓ | A valid URL for the voice recording |
title | string | ✓ | Recording title |
caption | string | Optional. Caption, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the voice message caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
voice_duration | integer | Optional. Recording duration in seconds | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message | |
input_message_content | InputMessageContent | Optional. Content of the message to be sent instead of the voice recording |
InputChecklist
Describes a checklist to create.
| field | type | required | description |
|---|---|---|---|
title | string | ✓ | Title of the checklist; 1-255 characters after entities parsing |
parse_mode | string | Optional. Mode for parsing entities in the title. See formatting options for more details. | |
title_entities | MessageEntity[] | Optional. 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. | |
tasks | InputChecklistTask[] | ✓ | List of 1-30 tasks in the checklist |
others_can_add_tasks | boolean | Optional. Pass True if other users can add tasks to the checklist | |
others_can_mark_tasks_as_done | boolean | Optional. Pass True if other users can mark tasks as done or not done in the checklist |
InputChecklistTask
Describes a task to add to a checklist.
| field | type | required | description |
|---|---|---|---|
id | integer | ✓ | Unique identifier of the task; must be positive and unique among all task identifiers currently present in the checklist |
text | string | ✓ | Text of the task; 1-100 characters after entities parsing |
parse_mode | string | Optional. Mode for parsing entities in the text. See formatting options for more details. | |
text_entities | MessageEntity[] | Optional. 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. |
InputContactMessageContent
Represents the content of a contact message to be sent as the result of an inline query.
| field | type | required | description |
|---|---|---|---|
phone_number | string | ✓ | Contact's phone number |
first_name | string | ✓ | Contact's first name |
last_name | string | Optional. Contact's last name | |
vcard | string | Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes |
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.
InputInvoiceMessageContent
Represents the content of an invoice message to be sent as the result of an inline query.
| field | type | required | description |
|---|---|---|---|
title | string | ✓ | Product name, 1-32 characters |
description | string | ✓ | Product description, 1-255 characters |
payload | string | ✓ | Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes. |
provider_token | string | Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars. | |
currency | string | ✓ | Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars. |
prices | LabeledPrice[] | ✓ | Price 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_amount | integer | Optional. 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_amounts | integer[] | Optional. 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_data | string | Optional. 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_url | string | Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. | |
photo_size | integer | Optional. Photo size in bytes | |
photo_width | integer | Optional. Photo width | |
photo_height | integer | Optional. Photo height | |
need_name | boolean | Optional. Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars. | |
need_phone_number | boolean | Optional. Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars. | |
need_email | boolean | Optional. Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars. | |
need_shipping_address | boolean | Optional. Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars. | |
send_phone_number_to_provider | boolean | Optional. Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars. | |
send_email_to_provider | boolean | Optional. Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars. | |
is_flexible | boolean | Optional. Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars. |
InputLocationMessageContent
Represents the content of a location message to be sent as the result of an inline query.
| field | type | required | description |
|---|---|---|---|
latitude | float | ✓ | Latitude of the location in degrees |
longitude | float | ✓ | Longitude of the location in degrees |
horizontal_accuracy | float | Optional. The radius of uncertainty for the location, measured in meters; 0-1500 | |
live_period | integer | Optional. 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 | |
heading | integer | Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. | |
proximity_alert_radius | integer | Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. |
InputMedia
This object represents the content of a media message to be sent. It should be one of
one of: InputMediaAnimation, InputMediaAudio, InputMediaDocument, InputMediaLivePhoto, InputMediaPhoto, InputMediaVideo
InputMediaAnimation
Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
| field | type | required | description |
|---|---|---|---|
type | animation | ✓ | Type of the result, must be animation |
media | string | ✓ | File 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 » |
thumbnail | string | Optional. 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 » | |
caption | string | Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the animation caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
width | integer | Optional. Animation width | |
height | integer | Optional. Animation height | |
duration | integer | Optional. Animation duration in seconds | |
has_spoiler | boolean | Optional. 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.
| field | type | required | description |
|---|---|---|---|
type | audio | ✓ | Type of the result, must be audio |
media | string | ✓ | File 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 » |
thumbnail | string | Optional. 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 » | |
caption | string | Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the audio caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
duration | integer | Optional. Duration of the audio in seconds | |
performer | string | Optional. Performer of the audio | |
title | string | Optional. Title of the audio |
InputMediaDocument
Represents a general file to be sent.
| field | type | required | description |
|---|---|---|---|
type | document | ✓ | Type of the result, must be document |
media | string | ✓ | File 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 » |
thumbnail | string | Optional. 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 » | |
caption | string | Optional. Caption of the document to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the document caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
disable_content_type_detection | boolean | Optional. 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.
| field | type | required | description |
|---|---|---|---|
type | live_photo | ✓ | Type of the result, must be live_photo |
media | string | ✓ | Video 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. |
photo | string | ✓ | The 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. |
caption | string | Optional. Caption of the live photo to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the live photo caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
has_spoiler | boolean | Optional. Pass True if the live photo needs to be covered with a spoiler animation |
InputMediaLocation
Represents a location to be sent.
| field | type | required | description |
|---|---|---|---|
type | location | ✓ | Type of the result, must be location |
latitude | float | ✓ | Latitude of the location |
longitude | float | ✓ | Longitude of the location |
horizontal_accuracy | float | Optional. The radius of uncertainty for the location, measured in meters; 0-1500 |
InputMediaPhoto
Represents a photo to be sent.
| field | type | required | description |
|---|---|---|---|
type | photo | ✓ | Type of the result, must be photo |
media | string | ✓ | File 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 » |
caption | string | Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the photo caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
has_spoiler | boolean | Optional. Pass True if the photo needs to be covered with a spoiler animation |
InputMediaSticker
Represents a sticker file to be sent.
| field | type | required | description |
|---|---|---|---|
type | sticker | ✓ | Type of the result, must be sticker |
media | string | ✓ | File 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 » |
emoji | string | Optional. Emoji associated with the sticker; only for just uploaded stickers |
InputMediaVenue
Represents a venue to be sent.
| field | type | required | description |
|---|---|---|---|
type | venue | ✓ | Type of the result, must be venue |
latitude | float | ✓ | Latitude of the location |
longitude | float | ✓ | Longitude of the location |
title | string | ✓ | Name of the venue |
address | string | ✓ | Address of the venue |
foursquare_id | string | Optional. Foursquare identifier of the venue | |
foursquare_type | string | Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) | |
google_place_id | string | Optional. Google Places identifier of the venue | |
google_place_type | string | Optional. Google Places type of the venue. (See supported types.) |
InputMediaVideo
Represents a video to be sent.
| field | type | required | description |
|---|---|---|---|
type | video | ✓ | Type of the result, must be video |
media | string | ✓ | File 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 » |
thumbnail | string | Optional. 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 » | |
cover | string | Optional. 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_timestamp | integer | Optional. Start timestamp for the video in the message | |
caption | string | Optional. Caption of the video to be sent, 0-1024 characters after entities parsing | |
parse_mode | string | Optional. Mode for parsing entities in the video caption. See formatting options for more details. | |
caption_entities | MessageEntity[] | Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode | |
show_caption_above_media | boolean | Optional. Pass True, if the caption must be shown above the message media | |
width | integer | Optional. Video width | |
height | integer | Optional. Video height | |
duration | integer | Optional. Video duration in seconds | |
supports_streaming | boolean | Optional. Pass True if the uploaded video is suitable for streaming | |
has_spoiler | boolean | Optional. Pass True if the video needs to be covered with a spoiler animation |
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:
one of: InputTextMessageContent, InputLocationMessageContent, InputVenueMessageContent, InputContactMessageContent, InputInvoiceMessageContent
InputPaidMedia
This object describes the paid media to be sent. Currently, it can be one of
one of: InputPaidMediaLivePhoto, InputPaidMediaPhoto, InputPaidMediaVideo
InputPaidMediaLivePhoto
The paid media to send is a live photo.
| field | type | required | description |
|---|---|---|---|
type | live_photo | ✓ | Type of the media, must be live_photo |
media | string | ✓ | Video 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. |
photo | string | ✓ | The 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.
| field | type | required | description |
|---|---|---|---|
type | photo | ✓ | Type of the media, must be photo |
media | string | ✓ | File 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.
| field | type | required | description |
|---|---|---|---|
type | video | ✓ | Type of the media, must be video |
media | string | ✓ | File 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 » |
thumbnail | string | Optional. 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 » | |
cover | string | Optional. 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_timestamp | integer | Optional. Start timestamp for the video in the message | |
width | integer | Optional. Video width | |
height | integer | Optional. Video height | |
duration | integer | Optional. Video duration in seconds | |
supports_streaming | boolean | Optional. Pass True if the uploaded video is suitable for streaming |
InputPollMedia
This object represents the content of a poll description or a quiz explanation to be sent. It should be one of
one of: InputMediaAnimation, InputMediaAudio, InputMediaDocument, InputMediaLivePhoto, InputMediaLocation, InputMediaPhoto, InputMediaVenue, InputMediaVideo
InputPollOption
This object contains information about one answer option in a poll to be sent.
| field | type | required | description |
|---|---|---|---|
text | string | ✓ | Option text, 1-100 characters |
text_parse_mode | string | Optional. Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed. | |
text_entities | MessageEntity[] | Optional. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode. | |
media | InputPollOptionMedia | Optional. Media added to the poll option |
InputPollOptionMedia
This object represents the content of a poll option to be sent. It should be one of
one of: InputMediaAnimation, InputMediaLivePhoto, InputMediaLocation, InputMediaPhoto, InputMediaSticker, InputMediaVenue, InputMediaVideo
InputProfilePhoto
This object describes a profile photo to set. Currently, it can be one of
one of: InputProfilePhotoStatic, InputProfilePhotoAnimated
InputProfilePhotoAnimated
An animated profile photo in the MPEG4 format.
| field | type | required | description |
|---|---|---|---|
type | animated | ✓ | Type of the profile photo, must be animated |
animation | string | ✓ | The 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_timestamp | float | Optional. Timestamp in seconds of the frame that will be used as the static profile photo. Defaults to 0.0. |
InputProfilePhotoStatic
A static profile photo in the .JPG format.
| field | type | required | description |
|---|---|---|---|
type | static | ✓ | Type of the profile photo, must be static |
photo | string | ✓ | The 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 » |
InputSticker
This object describes a sticker to be added to a sticker set.
| field | type | required | description |
|---|---|---|---|
sticker | string | ✓ | The 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 » |
format | static | animated | video | ✓ | Format 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_list | string[] | ✓ | List of 1-20 emoji associated with the sticker |
mask_position | MaskPosition | Optional. Position where the mask should be placed on faces. For “mask” stickers only. | |
keywords | string[] | Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular” and “custom_emoji” stickers only. |
InputStoryContent
This object describes the content of a story to post. Currently, it can be one of
one of: InputStoryContentPhoto, InputStoryContentVideo
InputStoryContentPhoto
Describes a photo to post as a story.
| field | type | required | description |
|---|---|---|---|
type | photo | ✓ | Type of the content, must be photo |
photo | string | ✓ | The 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.
| field | type | required | description |
|---|---|---|---|
type | video | ✓ | Type of the content, must be video |
video | string | ✓ | The 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 » |
duration | float | Optional. Precise duration of the video in seconds; 0-60 | |
cover_frame_timestamp | float | Optional. Timestamp in seconds of the frame that will be used as the static cover for the story. Defaults to 0.0. | |
is_animation | boolean | Optional. Pass True if the video has no sound |
InputTextMessageContent
Represents the content of a text message to be sent as the result of an inline query.
| field | type | required | description |
|---|---|---|---|
message_text | string | ✓ | Text of the message to be sent, 1-4096 characters |
parse_mode | string | Optional. Mode for parsing entities in the message text. See formatting options for more details. | |
entities | MessageEntity[] | Optional. List of special entities that appear in message text, which can be specified instead of parse_mode | |
link_preview_options | LinkPreviewOptions | Optional. Link preview generation options for the message |
InputVenueMessageContent
Represents the content of a venue message to be sent as the result of an inline query.
| field | type | required | description |
|---|---|---|---|
latitude | float | ✓ | Latitude of the venue in degrees |
longitude | float | ✓ | Longitude of the venue in degrees |
title | string | ✓ | Name of the venue |
address | string | ✓ | Address of the venue |
foursquare_id | string | Optional. Foursquare identifier of the venue, if known | |
foursquare_type | string | Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) | |
google_place_id | string | Optional. Google Places identifier of the venue | |
google_place_type | string | Optional. Google Places type of the venue. (See supported types.) |
Invoice
This object contains basic information about an invoice.
| field | type | required | description |
|---|---|---|---|
title | string | ✓ | Product name |
description | string | ✓ | Product description |
start_parameter | string | ✓ | Unique bot deep-linking parameter that can be used to generate this invoice |
currency | string | ✓ | Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars |
total_amount | integer | ✓ | Total 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). |
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.
| field | type | required | description |
|---|---|---|---|
text | string | ✓ | Text 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_id | string | Optional. 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. | |
style | danger | success | primary | Optional. 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_users | KeyboardButtonRequestUsers | Optional. 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_chat | KeyboardButtonRequestChat | Optional. 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_bot | KeyboardButtonRequestManagedBot | Optional. 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_contact | boolean | Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only. | |
request_location | boolean | Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only. | |
request_poll | KeyboardButtonPollType | Optional. 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_app | WebAppInfo | Optional. 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. |
KeyboardButtonPollType
This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
| field | type | required | description |
|---|---|---|---|
type | string | Optional. 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. |
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 ».
| field | type | required | description |
|---|---|---|---|
request_id | integer | ✓ | Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique within the message. |
chat_is_channel | boolean | ✓ | Pass True to request a channel chat, pass False to request a group or a supergroup chat |
chat_is_forum | boolean | Optional. 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_username | boolean | Optional. 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_created | boolean | Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied. | |
user_administrator_rights | ChatAdministratorRights | Optional. 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_rights | ChatAdministratorRights | Optional. 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_member | boolean | Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied. | |
request_title | boolean | Optional. Pass True to request the chat's title | |
request_username | boolean | Optional. Pass True to request the chat's username | |
request_photo | boolean | Optional. 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.
| field | type | required | description |
|---|---|---|---|
request_id | integer | ✓ | Signed 32-bit identifier of the request. Must be unique within the message. |
suggested_name | string | Optional. Suggested name for the bot | |
suggested_username | string | Optional. Suggested username for the bot |
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 »
| field | type | required | description |
|---|---|---|---|
request_id | integer | ✓ | Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within the message. |
user_is_bot | boolean | Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional restrictions are applied. | |
user_is_premium | boolean | Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied. | |
max_quantity | integer | Optional. The maximum number of users to be selected; 1-10. Defaults to 1. | |
request_name | boolean | Optional. Pass True to request the users' first and last names | |
request_username | boolean | Optional. Pass True to request the users' usernames | |
request_photo | boolean | Optional. Pass True to request the users' photos |
LabeledPrice
This object represents a portion of the price for goods or services.
| field | type | required | description |
|---|---|---|---|
label | string | ✓ | Portion label |
amount | integer | ✓ | Price 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). |
LinkPreviewOptions
Describes the options used for link preview generation.
| field | type | required | description |
|---|---|---|---|
is_disabled | boolean | Optional. True, if the link preview is disabled | |
url | string | Optional. URL to use for the link preview. If empty, then the first URL found in the message text will be used. | |
prefer_small_media | boolean | Optional. 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_media | boolean | Optional. 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_text | boolean | Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text |
LivePhoto
This object represents a live photo.
| field | type | required | description |
|---|---|---|---|
photo | PhotoSize[] | Optional. Available sizes of the corresponding static photo | |
file_id | string | ✓ | Identifier for the video file which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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. |
width | integer | ✓ | Video width as defined by the sender |
height | integer | ✓ | Video height as defined by the sender |
duration | integer | ✓ | Duration of the video in seconds as defined by the sender |
mime_type | string | Optional. MIME type of the file as defined by the sender | |
file_size | integer | Optional. 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. |
Location
This object represents a point on the map.
| field | type | required | description |
|---|---|---|---|
latitude | float | ✓ | Latitude as defined by the sender |
longitude | float | ✓ | Longitude as defined by the sender |
horizontal_accuracy | float | Optional. The radius of uncertainty for the location, measured in meters; 0-1500 | |
live_period | integer | Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only. | |
heading | integer | Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only. | |
proximity_alert_radius | integer | Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only. |
LocationAddress
Describes the physical address of a location.
| field | type | required | description |
|---|---|---|---|
country_code | string | ✓ | The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located |
state | string | Optional. State of the location | |
city | string | Optional. City of the location | |
street | string | Optional. Street address of the location |
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: Telegram apps support these buttons as of version 5.7.
| field | type | required | description |
|---|---|---|---|
url | string | ✓ | An 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_text | string | Optional. New text of the button in forwarded messages | |
bot_username | string | Optional. 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_access | boolean | Optional. Pass True to request the permission for your bot to send messages to the user |
ManagedBotCreated
This object contains information about the bot that was created to be managed by the current bot.
| field | type | required | description |
|---|---|---|---|
bot | User | ✓ | Information 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.
| field | type | required | description |
|---|---|---|---|
user | User | ✓ | User that created the bot |
bot | User | ✓ | Information about the bot. Token of the bot can be fetched using the method getManagedBotToken. |
MaskPosition
This object describes the position on faces where a mask should be placed by default.
| field | type | required | description |
|---|---|---|---|
point | forehead | eyes | mouth | chin | ✓ | The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”. |
x_shift | float | ✓ | Shift 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_shift | float | ✓ | Shift 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. |
scale | float | ✓ | Mask scaling coefficient. For example, 2.0 means double size. |
MaybeInaccessibleMessage
This object describes a message that can be inaccessible to the bot. It can be one of
one of: Message, InaccessibleMessage
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.
one of: MenuButtonCommands, MenuButtonWebApp, MenuButtonDefault
MenuButtonCommands
Represents a menu button, which opens the bot's list of commands.
| field | type | required | description |
|---|---|---|---|
type | commands | ✓ | Type of the button, must be commands |
MenuButtonDefault
Describes that no specific value for the menu button was set.
| field | type | required | description |
|---|---|---|---|
type | default | ✓ | Type of the button, must be default |
MenuButtonWebApp
Represents a menu button, which launches a Web App.
| field | type | required | description |
|---|---|---|---|
type | web_app | ✓ | Type of the button, must be web_app |
text | string | ✓ | Text on the button |
web_app | WebAppInfo | ✓ | 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. 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. |
Message
This object represents a message.
| field | type | required | description |
|---|---|---|---|
message_id | integer | ✓ | Unique 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_id | integer | Optional. Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and private chats only | |
direct_messages_topic | DirectMessagesTopic | Optional. Information about the direct messages chat topic that contains the message | |
from | User | Optional. 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_chat | Chat | Optional. 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_count | integer | Optional. If the sender of the message boosted the chat, the number of boosts added by the user | |
sender_business_bot | User | Optional. 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_tag | string | Optional. Tag or custom title of the sender of the message; for supergroups only | |
date | integer | ✓ | Date the message was sent in Unix time. It is always a positive number, representing a valid date. |
guest_query_id | string | Optional. 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_id | string | Optional. 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. | |
chat | Chat | ✓ | Chat the message belongs to |
forward_origin | MessageOrigin | Optional. Information about the original message for forwarded messages | |
is_topic_message | true | Optional. True, if the message is sent to a topic in a forum supergroup or a private chat with the bot | |
is_automatic_forward | true | Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group | |
reply_to_message | Message | Optional. 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_reply | ExternalReplyInfo | Optional. Information about the message that is being replied to, which may come from another chat or forum topic | |
quote | TextQuote | Optional. For replies that quote part of the original message, the quoted part of the message | |
reply_to_story | Story | Optional. For replies to a story, the original story | |
reply_to_checklist_task_id | integer | Optional. Identifier of the specific checklist task that is being replied to | |
reply_to_poll_option_id | string | Optional. Persistent identifier of the specific poll option that is being replied to | |
via_bot | User | Optional. Bot through which the message was sent | |
guest_bot_caller_user | User | Optional. For a message sent by a guest bot, this is the user whose original message triggered the bot's response | |
guest_bot_caller_chat | Chat | Optional. For a message sent by a guest bot, this is the chat whose original message triggered the bot's response | |
edit_date | integer | Optional. Date the message was last edited in Unix time | |
has_protected_content | true | Optional. True, if the message can't be forwarded | |
is_from_offline | true | Optional. 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_post | true | Optional. 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_id | string | Optional. The unique identifier inside this chat of a media message group this message belongs to | |
author_signature | string | Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator | |
paid_star_count | integer | Optional. The number of Telegram Stars that were paid by the sender of the message to send it | |
text | string | Optional. For text messages, the actual UTF-8 text of the message | |
entities | MessageEntity[] | Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text | |
link_preview_options | LinkPreviewOptions | Optional. Options used for link preview generation for the message, if it is a text message and link preview options were changed | |
suggested_post_info | SuggestedPostInfo | Optional. 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_id | string | Optional. Unique identifier of the message effect added to the message | |
animation | Animation | Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set. | |
audio | Audio | Optional. Message is an audio file, information about the file | |
document | Document | Optional. Message is a general file, information about the file | |
live_photo | LivePhoto | Optional. 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_media | PaidMediaInfo | Optional. Message contains paid media; information about the paid media | |
photo | PhotoSize[] | Optional. Message is a photo, available sizes of the photo | |
sticker | Sticker | Optional. Message is a sticker, information about the sticker | |
story | Story | Optional. Message is a forwarded story | |
video | Video | Optional. Message is a video, information about the video | |
video_note | VideoNote | Optional. Message is a video note, information about the video message | |
voice | Voice | Optional. Message is a voice message, information about the file | |
caption | string | Optional. Caption for the animation, audio, document, paid media, photo, video or voice | |
caption_entities | MessageEntity[] | Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption | |
show_caption_above_media | true | Optional. True, if the caption must be shown above the message media | |
has_media_spoiler | true | Optional. True, if the message media is covered by a spoiler animation | |
checklist | Checklist | Optional. Message is a checklist | |
contact | Contact | Optional. Message is a shared contact, information about the contact | |
dice | Dice | Optional. Message is a dice with random value | |
game | Game | Optional. Message is a game, information about the game. More about games » | |
poll | Poll | Optional. Message is a native poll, information about the poll | |
venue | Venue | Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set. | |
location | Location | Optional. Message is a shared location, information about the location | |
new_chat_members | User[] | Optional. 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_member | User | Optional. A member was removed from the group, information about them (this member may be the bot itself) | |
chat_owner_left | ChatOwnerLeft | Optional. Service message: chat owner has left | |
chat_owner_changed | ChatOwnerChanged | Optional. Service message: chat owner has changed | |
new_chat_title | string | Optional. A chat title was changed to this value | |
new_chat_photo | PhotoSize[] | Optional. A chat photo was change to this value | |
delete_chat_photo | true | Optional. Service message: the chat photo was deleted | |
group_chat_created | true | Optional. Service message: the group has been created | |
supergroup_chat_created | true | Optional. Service message: the supergroup has been created. 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_created | true | Optional. 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_changed | MessageAutoDeleteTimerChanged | Optional. Service message: auto-delete timer settings changed in the chat | |
migrate_to_chat_id | integer | Optional. 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_id | integer | Optional. 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_message | MaybeInaccessibleMessage | Optional. 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. | |
invoice | Invoice | Optional. Message is an invoice for a payment, information about the invoice. More about payments » | |
successful_payment | SuccessfulPayment | Optional. Message is a service message about a successful payment, information about the payment. More about payments » | |
refunded_payment | RefundedPayment | Optional. Message is a service message about a refunded payment, information about the payment. More about payments » | |
users_shared | UsersShared | Optional. Service message: users were shared with the bot | |
chat_shared | ChatShared | Optional. Service message: a chat was shared with the bot | |
gift | GiftInfo | Optional. Service message: a regular gift was sent or received | |
unique_gift | UniqueGiftInfo | Optional. Service message: a unique gift was sent or received | |
gift_upgrade_sent | GiftInfo | Optional. Service message: upgrade of a gift was purchased after the gift was sent | |
connected_website | string | Optional. The domain name of the website on which the user has logged in. More about Telegram Login » | |
write_access_allowed | WriteAccessAllowed | Optional. 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_data | PassportData | Optional. Telegram Passport data | |
proximity_alert_triggered | ProximityAlertTriggered | Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location. | |
boost_added | ChatBoostAdded | Optional. Service message: user boosted the chat | |
chat_background_set | ChatBackground | Optional. Service message: chat background set | |
checklist_tasks_done | ChecklistTasksDone | Optional. Service message: some tasks in a checklist were marked as done or not done | |
checklist_tasks_added | ChecklistTasksAdded | Optional. Service message: tasks were added to a checklist | |
direct_message_price_changed | DirectMessagePriceChanged | Optional. Service message: the price for paid messages in the corresponding direct messages chat of a channel has changed | |
forum_topic_created | ForumTopicCreated | Optional. Service message: forum topic created | |
forum_topic_edited | ForumTopicEdited | Optional. Service message: forum topic edited | |
forum_topic_closed | ForumTopicClosed | Optional. Service message: forum topic closed | |
forum_topic_reopened | ForumTopicReopened | Optional. Service message: forum topic reopened | |
general_forum_topic_hidden | GeneralForumTopicHidden | Optional. Service message: the 'General' forum topic hidden | |
general_forum_topic_unhidden | GeneralForumTopicUnhidden | Optional. Service message: the 'General' forum topic unhidden | |
giveaway_created | GiveawayCreated | Optional. Service message: a scheduled giveaway was created | |
giveaway | Giveaway | Optional. The message is a scheduled giveaway message | |
giveaway_winners | GiveawayWinners | Optional. A giveaway with public winners was completed | |
giveaway_completed | GiveawayCompleted | Optional. Service message: a giveaway without public winners was completed | |
managed_bot_created | ManagedBotCreated | Optional. Service message: user created a bot that will be managed by the current bot | |
paid_message_price_changed | PaidMessagePriceChanged | Optional. Service message: the price for paid messages has changed in the chat | |
poll_option_added | PollOptionAdded | Optional. Service message: answer option was added to a poll | |
poll_option_deleted | PollOptionDeleted | Optional. Service message: answer option was deleted from a poll | |
suggested_post_approved | SuggestedPostApproved | Optional. Service message: a suggested post was approved | |
suggested_post_approval_failed | SuggestedPostApprovalFailed | Optional. Service message: approval of a suggested post has failed | |
suggested_post_declined | SuggestedPostDeclined | Optional. Service message: a suggested post was declined | |
suggested_post_paid | SuggestedPostPaid | Optional. Service message: payment for a suggested post was received | |
suggested_post_refunded | SuggestedPostRefunded | Optional. Service message: payment for a suggested post was refunded | |
video_chat_scheduled | VideoChatScheduled | Optional. Service message: video chat scheduled | |
video_chat_started | VideoChatStarted | Optional. Service message: video chat started | |
video_chat_ended | VideoChatEnded | Optional. Service message: video chat ended | |
video_chat_participants_invited | VideoChatParticipantsInvited | Optional. Service message: new participants invited to a video chat | |
web_app_data | WebAppData | Optional. Service message: data sent by a Web App | |
reply_markup | InlineKeyboardMarkup | Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons. |
MessageAutoDeleteTimerChanged
This object represents a service message about a change in auto-delete timer settings.
| field | type | required | description |
|---|---|---|---|
message_auto_delete_time | integer | ✓ | New auto-delete time for messages in the chat; in seconds |
MessageEntity
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
| field | type | required | description |
|---|---|---|---|
type | mention | hashtag | cashtag | bot_command | url | email | phone_number | bold | italic | underline | strikethrough | spoiler | blockquote | expandable_blockquote | code | pre | text_link | text_mention | custom_emoji | date_time | ✓ | Type 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” ([email protected]), “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). |
offset | integer | ✓ | Offset in UTF-16 code units to the start of the entity |
length | integer | ✓ | Length of the entity in UTF-16 code units |
url | string | Optional. For “text_link” only, URL that will be opened after user taps on the text | |
user | User | Optional. For “text_mention” only, the mentioned user | |
language | string | Optional. For “pre” only, the programming language of the entity text | |
custom_emoji_id | string | Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker. | |
unix_time | integer | Optional. For “date_time” only, the Unix time associated with the entity | |
date_time_format | string | Optional. For “date_time” only, the string that defines the formatting of the date and time. See date-time entity formatting for more details. |
MessageId
This object represents a unique message identifier.
| field | type | required | description |
|---|---|---|---|
message_id | integer | ✓ | Unique 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. |
MessageOrigin
This object describes the origin of a message. It can be one of
one of: MessageOriginUser, MessageOriginHiddenUser, MessageOriginChat, MessageOriginChannel
MessageOriginChannel
The message was originally sent to a channel chat.
| field | type | required | description |
|---|---|---|---|
type | channel | ✓ | Type of the message origin, always “channel” |
date | integer | ✓ | Date the message was sent originally in Unix time |
chat | Chat | ✓ | Channel chat to which the message was originally sent |
message_id | integer | ✓ | Unique message identifier inside the chat |
author_signature | string | Optional. Signature of the original post author |
MessageOriginChat
The message was originally sent on behalf of a chat to a group chat.
| field | type | required | description |
|---|---|---|---|
type | chat | ✓ | Type of the message origin, always “chat” |
date | integer | ✓ | Date the message was sent originally in Unix time |
sender_chat | Chat | ✓ | Chat that sent the message originally |
author_signature | string | Optional. For messages originally sent by an anonymous chat administrator, original message author signature |
MessageOriginHiddenUser
The message was originally sent by an unknown user.
| field | type | required | description |
|---|---|---|---|
type | hidden_user | ✓ | Type of the message origin, always “hidden_user” |
date | integer | ✓ | Date the message was sent originally in Unix time |
sender_user_name | string | ✓ | Name of the user that sent the message originally |
MessageOriginUser
The message was originally sent by a known user.
| field | type | required | description |
|---|---|---|---|
type | user | ✓ | Type of the message origin, always “user” |
date | integer | ✓ | Date the message was sent originally in Unix time |
sender_user | User | ✓ | User that sent the message originally |
MessageReactionCountUpdated
This object represents reaction changes on a message with anonymous reactions.
| field | type | required | description |
|---|---|---|---|
chat | Chat | ✓ | The chat containing the message |
message_id | integer | ✓ | Unique message identifier inside the chat |
date | integer | ✓ | Date of the change in Unix time |
reactions | ReactionCount[] | ✓ | List of reactions that are present on the message |
MessageReactionUpdated
This object represents a change of a reaction on a message performed by a user.
| field | type | required | description |
|---|---|---|---|
chat | Chat | ✓ | The chat containing the message the user reacted to |
message_id | integer | ✓ | Unique identifier of the message inside the chat |
user | User | Optional. The user that changed the reaction, if the user isn't anonymous | |
actor_chat | Chat | Optional. The chat on behalf of which the reaction was changed, if the user is anonymous | |
date | integer | ✓ | Date of the change in Unix time |
old_reaction | ReactionType[] | ✓ | Previous list of reaction types that were set by the user |
new_reaction | ReactionType[] | ✓ | New list of reaction types that have been set by the user |
OrderInfo
This object represents information about an order.
| field | type | required | description |
|---|---|---|---|
name | string | Optional. User name | |
phone_number | string | Optional. User's phone number | |
email | string | Optional. User email | |
shipping_address | ShippingAddress | Optional. User shipping address |
OwnedGift
This object describes a gift received and owned by a user or a chat. Currently, it can be one of
one of: OwnedGiftRegular, OwnedGiftUnique
OwnedGiftRegular
Describes a regular gift owned by a user or a chat.
| field | type | required | description |
|---|---|---|---|
type | regular | ✓ | Type of the gift, always “regular” |
gift | Gift | ✓ | Information about the regular gift |
owned_gift_id | string | Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only | |
sender_user | User | Optional. Sender of the gift if it is a known user | |
send_date | integer | ✓ | Date the gift was sent in Unix time |
text | string | Optional. Text of the message that was added to the gift | |
entities | MessageEntity[] | Optional. Special entities that appear in the text | |
is_private | true | Optional. True, if the sender and gift text are shown only to the gift receiver; otherwise, everyone will be able to see them | |
is_saved | true | Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only | |
can_be_upgraded | true | Optional. True, if the gift can be upgraded to a unique gift; for gifts received on behalf of business accounts only | |
was_refunded | true | Optional. True, if the gift was refunded and isn't available anymore | |
convert_star_count | integer | Optional. 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_count | integer | Optional. Number of Telegram Stars that were paid for the ability to upgrade the gift | |
is_upgrade_separate | true | Optional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of business accounts only | |
unique_gift_number | integer | Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift. |
OwnedGifts
Contains the list of gifts received and owned by a user or a chat.
| field | type | required | description |
|---|---|---|---|
total_count | integer | ✓ | The total number of gifts owned by the user or the chat |
gifts | OwnedGift[] | ✓ | The list of gifts |
next_offset | string | Optional. Offset for the next request. If empty, then there are no more results. |
OwnedGiftUnique
Describes a unique gift received and owned by a user or a chat.
| field | type | required | description |
|---|---|---|---|
type | unique | ✓ | Type of the gift, always “unique” |
gift | UniqueGift | ✓ | Information about the unique gift |
owned_gift_id | string | Optional. Unique identifier of the received gift for the bot; for gifts received on behalf of business accounts only | |
sender_user | User | Optional. Sender of the gift if it is a known user | |
send_date | integer | ✓ | Date the gift was sent in Unix time |
is_saved | true | Optional. True, if the gift is displayed on the account's profile page; for gifts received on behalf of business accounts only | |
can_be_transferred | true | Optional. True, if the gift can be transferred to another owner; for gifts received on behalf of business accounts only | |
transfer_star_count | integer | Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift | |
next_transfer_date | integer | Optional. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now. |
PaidMedia
This object describes paid media. Currently, it can be one of
one of: PaidMediaLivePhoto, PaidMediaPhoto, PaidMediaPreview, PaidMediaVideo
PaidMediaInfo
Describes the paid media added to a message.
| field | type | required | description |
|---|---|---|---|
star_count | integer | ✓ | The number of Telegram Stars that must be paid to buy access to the media |
paid_media | PaidMedia[] | ✓ | Information about the paid media |
PaidMediaLivePhoto
The paid media is a live photo.
| field | type | required | description |
|---|---|---|---|
type | live_photo | ✓ | Type of the paid media, always “live_photo” |
live_photo | LivePhoto | ✓ | The photo |
PaidMediaPhoto
The paid media is a photo.
| field | type | required | description |
|---|---|---|---|
type | photo | ✓ | Type of the paid media, always “photo” |
photo | PhotoSize[] | ✓ | The photo |
PaidMediaPreview
The paid media isn't available before the payment.
| field | type | required | description |
|---|---|---|---|
type | preview | ✓ | Type of the paid media, always “preview” |
width | integer | Optional. Media width as defined by the sender | |
height | integer | Optional. Media height as defined by the sender | |
duration | integer | Optional. Duration of the media in seconds as defined by the sender |
PaidMediaPurchased
This object contains information about a paid media purchase.
| field | type | required | description |
|---|---|---|---|
from | User | ✓ | User who purchased the media |
paid_media_payload | string | ✓ | Bot-specified paid media payload |
PaidMediaVideo
The paid media is a video.
| field | type | required | description |
|---|---|---|---|
type | video | ✓ | Type of the paid media, always “video” |
video | Video | ✓ | The video |
PaidMessagePriceChanged
Describes a service message about a change in the price of paid messages within a chat.
| field | type | required | description |
|---|---|---|---|
paid_message_star_count | integer | ✓ | The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each sent message |
PassportData
Describes Telegram Passport data shared with the bot by the user.
| field | type | required | description |
|---|---|---|---|
data | EncryptedPassportElement[] | ✓ | Array with information about documents and other Telegram Passport elements that was shared with the bot |
credentials | EncryptedCredentials | ✓ | Encrypted credentials required to decrypt the data |
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:
one of: PassportElementErrorDataField, PassportElementErrorFrontSide, PassportElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile, PassportElementErrorFiles, PassportElementErrorTranslationFile, PassportElementErrorTranslationFiles, PassportElementErrorUnspecified
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.
| field | type | required | description |
|---|---|---|---|
source | data | ✓ | Error source, must be data |
type | personal_details | passport | driver_license | identity_card | internal_passport | address | ✓ | The section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address” |
field_name | string | ✓ | Name of the data field which has the error |
data_hash | string | ✓ | Base64-encoded data hash |
message | string | ✓ | Error message |
PassportElementErrorFile
Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
| field | type | required | description |
|---|---|---|---|
source | file | ✓ | Error source, must be file |
type | utility_bill | bank_statement | rental_agreement | passport_registration | temporary_registration | ✓ | The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” |
file_hash | string | ✓ | Base64-encoded file hash |
message | string | ✓ | Error message |
PassportElementErrorFiles
Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
| field | type | required | description |
|---|---|---|---|
source | files | ✓ | Error source, must be files |
type | utility_bill | bank_statement | rental_agreement | passport_registration | temporary_registration | ✓ | The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration” |
file_hashes | string[] | ✓ | List of base64-encoded file hashes |
message | string | ✓ | Error 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.
| field | type | required | description |
|---|---|---|---|
source | front_side | ✓ | Error source, must be front_side |
type | passport | driver_license | identity_card | internal_passport | ✓ | The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport” |
file_hash | string | ✓ | Base64-encoded hash of the file with the front side of the document |
message | string | ✓ | Error 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.
| field | type | required | description |
|---|---|---|---|
source | reverse_side | ✓ | Error source, must be reverse_side |
type | driver_license | identity_card | ✓ | The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card” |
file_hash | string | ✓ | Base64-encoded hash of the file with the reverse side of the document |
message | string | ✓ | Error message |
PassportElementErrorSelfie
Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
| field | type | required | description |
|---|---|---|---|
source | selfie | ✓ | Error source, must be selfie |
type | passport | driver_license | identity_card | internal_passport | ✓ | The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport” |
file_hash | string | ✓ | Base64-encoded hash of the file with the selfie |
message | string | ✓ | Error 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.
| field | type | required | description |
|---|---|---|---|
source | translation_file | ✓ | Error source, must be translation_file |
type | passport | driver_license | identity_card | internal_passport | utility_bill | bank_statement | rental_agreement | passport_registration | temporary_registration | ✓ | Type 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_hash | string | ✓ | Base64-encoded file hash |
message | string | ✓ | Error 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.
| field | type | required | description |
|---|---|---|---|
source | translation_files | ✓ | Error source, must be translation_files |
type | passport | driver_license | identity_card | internal_passport | utility_bill | bank_statement | rental_agreement | passport_registration | temporary_registration | ✓ | Type 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_hashes | string[] | ✓ | List of base64-encoded file hashes |
message | string | ✓ | Error message |
PassportElementErrorUnspecified
Represents an issue in an unspecified place. The error is considered resolved when new data is added.
| field | type | required | description |
|---|---|---|---|
source | unspecified | ✓ | Error source, must be unspecified |
type | string | ✓ | Type of element of the user's Telegram Passport which has the issue |
element_hash | string | ✓ | Base64-encoded element hash |
message | string | ✓ | Error message |
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.
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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_size | integer | ✓ | File size in bytes |
file_date | integer | ✓ | Unix time when the file was uploaded |
PhotoSize
This object represents one size of a photo or a file / sticker thumbnail.
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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. |
width | integer | ✓ | Photo width |
height | integer | ✓ | Photo height |
file_size | integer | Optional. File size in bytes |
Poll
This object contains information about a poll.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Unique poll identifier |
question | string | ✓ | Poll question, 1-300 characters |
question_entities | MessageEntity[] | Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll questions | |
options | PollOption[] | ✓ | List of poll options |
total_voter_count | integer | ✓ | Total number of users that voted in the poll |
is_closed | boolean | ✓ | True, if the poll is closed |
is_anonymous | boolean | ✓ | True, if the poll is anonymous |
type | regular | quiz | ✓ | Poll type, currently can be “regular” or “quiz” |
allows_multiple_answers | boolean | ✓ | True, if the poll allows multiple answers |
allows_revoting | boolean | ✓ | True, if the poll allows to change the chosen answer options |
members_only | boolean | ✓ | True 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_codes | string[] | Optional. 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_ids | integer[] | Optional. 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. | |
explanation | string | Optional. 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_entities | MessageEntity[] | Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation | |
explanation_media | PollMedia | Optional. Media added to the quiz explanation | |
open_period | integer | Optional. Amount of time in seconds the poll will be active after creation | |
close_date | integer | Optional. Point in time (Unix timestamp) when the poll will be automatically closed | |
description | string | Optional. Description of the poll; for polls inside the Message object only | |
description_entities | MessageEntity[] | Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the description | |
media | PollMedia | Optional. Media added to the poll description; for polls inside the Message object only |
PollAnswer
This object represents an answer of a user in a non-anonymous poll.
| field | type | required | description |
|---|---|---|---|
poll_id | string | ✓ | Unique poll identifier |
voter_chat | Chat | Optional. The chat that changed the answer to the poll, if the voter is anonymous | |
user | User | Optional. The user that changed the answer to the poll, if the voter isn't anonymous | |
option_ids | integer[] | ✓ | 0-based identifiers of chosen answer options. May be empty if the vote was retracted. |
option_persistent_ids | string[] | ✓ | Persistent identifiers of the chosen answer options. May be empty if the vote was retracted. |
PollMedia
At most one of the optional fields can be present in any given object.
| field | type | required | description |
|---|---|---|---|
animation | Animation | Optional. Media is an animation, information about the animation | |
audio | Audio | Optional. Media is an audio file, information about the file; currently, can't be received in a poll option | |
document | Document | Optional. Media is a general file, information about the file; currently, can't be received in a poll option | |
live_photo | LivePhoto | Optional. Media is a live photo, information about the live photo | |
location | Location | Optional. Media is a shared location, information about the location | |
photo | PhotoSize[] | Optional. Media is a photo, available sizes of the photo | |
sticker | Sticker | Optional. Media is a sticker, information about the sticker; currently, for poll options only | |
venue | Venue | Optional. Media is a venue, information about the venue | |
video | Video | Optional. Media is a video, information about the video |
PollOption
This object contains information about one answer option in a poll.
| field | type | required | description |
|---|---|---|---|
persistent_id | string | ✓ | Unique identifier of the option, persistent on option addition and deletion |
text | string | ✓ | Option text, 1-100 characters |
text_entities | MessageEntity[] | Optional. Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts | |
media | PollMedia | Optional. Media added to the poll option | |
voter_count | integer | ✓ | Number of users who voted for this option; may be 0 if unknown |
added_by_user | User | Optional. User who added the option; omitted if the option wasn't added by a user after poll creation | |
added_by_chat | Chat | Optional. Chat that added the option; omitted if the option wasn't added by a chat after poll creation | |
addition_date | integer | Optional. Point in time (Unix timestamp) when the option was added; omitted if the option existed in the original poll |
PollOptionAdded
Describes a service message about an option added to a poll.
| field | type | required | description |
|---|---|---|---|
poll_message | MaybeInaccessibleMessage | Optional. 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_id | string | ✓ | Unique identifier of the added option |
option_text | string | ✓ | Option text |
option_text_entities | MessageEntity[] | Optional. Special entities that appear in the option_text |
PollOptionDeleted
Describes a service message about an option deleted from a poll.
| field | type | required | description |
|---|---|---|---|
poll_message | MaybeInaccessibleMessage | Optional. 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_id | string | ✓ | Unique identifier of the deleted option |
option_text | string | ✓ | Option text |
option_text_entities | MessageEntity[] | Optional. Special entities that appear in the option_text |
PreCheckoutQuery
This object contains information about an incoming pre-checkout query.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Unique query identifier |
from | User | ✓ | User who sent the query |
currency | string | ✓ | Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars |
total_amount | integer | ✓ | Total 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_payload | string | ✓ | Bot-specified invoice payload |
shipping_option_id | string | Optional. Identifier of the shipping option chosen by the user | |
order_info | OrderInfo | Optional. Order information provided by the user |
PreparedInlineMessage
Describes an inline message to be sent by a user of a Mini App.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Unique identifier of the prepared message |
expiration_date | integer | ✓ | Expiration 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.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Unique identifier of the keyboard button |
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.
| field | type | required | description |
|---|---|---|---|
traveler | User | ✓ | User that triggered the alert |
watcher | User | ✓ | User that set the alert |
distance | integer | ✓ | The distance between the users |
ReactionCount
Represents a reaction added to a message along with the number of times it was added.
| field | type | required | description |
|---|---|---|---|
type | ReactionType | ✓ | Type of the reaction |
total_count | integer | ✓ | Number of times the reaction was added |
ReactionType
This object describes the type of a reaction. Currently, it can be one of
one of: ReactionTypeEmoji, ReactionTypeCustomEmoji, ReactionTypePaid
ReactionTypeCustomEmoji
The reaction is based on a custom emoji.
| field | type | required | description |
|---|---|---|---|
type | custom_emoji | ✓ | Type of the reaction, always “custom_emoji” |
custom_emoji_id | string | ✓ | Custom emoji identifier |
ReactionTypeEmoji
The reaction is based on an emoji.
| field | type | required | description |
|---|---|---|---|
type | emoji | ✓ | Type of the reaction, always “emoji” |
emoji | string | ✓ | Reaction emoji. Currently, it can be one of "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "". |
ReactionTypePaid
The reaction is paid.
| field | type | required | description |
|---|---|---|---|
type | paid | ✓ | Type of the reaction, always “paid” |
RefundedPayment
This object contains basic information about a refunded payment.
| field | type | required | description |
|---|---|---|---|
currency | string | ✓ | Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently, always “XTR”. |
total_amount | integer | ✓ | Total 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_payload | string | ✓ | Bot-specified invoice payload |
telegram_payment_charge_id | string | ✓ | Telegram payment identifier |
provider_payment_charge_id | string | Optional. Provider payment identifier |
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.
| field | type | required | description |
|---|---|---|---|
keyboard | KeyboardButton[][] | ✓ | Array of button rows, each represented by an Array of KeyboardButton objects |
is_persistent | boolean | Optional. 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_keyboard | boolean | Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard. | |
one_time_keyboard | boolean | Optional. Requests clients to hide the keyboard as soon as it's been used. 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_placeholder | string | Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters | |
selective | boolean | Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply 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. |
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.
| field | type | required | description |
|---|---|---|---|
remove_keyboard | true | ✓ | Requests 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) |
selective | boolean | Optional. 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. |
ReplyParameters
Describes reply parameters for the message that is being sent.
| field | type | required | description |
|---|---|---|---|
message_id | integer | ✓ | Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified |
chat_id | integer | string | Optional. 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_reply | boolean | Optional. 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. | |
quote | string | Optional. 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_mode | string | Optional. Mode for parsing entities in the quote. See formatting options for more details. | |
quote_entities | MessageEntity[] | Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode. | |
quote_position | integer | Optional. Position of the quote in the original message in UTF-16 code units | |
checklist_task_id | integer | Optional. Identifier of the specific checklist task to be replied to | |
poll_option_id | string | Optional. Persistent identifier of the specific poll option to be replied to |
ResponseParameters
Describes why a request was unsuccessful.
| field | type | required | description |
|---|---|---|---|
migrate_to_chat_id | integer | Optional. 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_after | integer | Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated |
RevenueWithdrawalState
This object describes the state of a revenue withdrawal operation. Currently, it can be one of
one of: RevenueWithdrawalStatePending, RevenueWithdrawalStateSucceeded, RevenueWithdrawalStateFailed
RevenueWithdrawalStateFailed
The withdrawal failed and the transaction was refunded.
| field | type | required | description |
|---|---|---|---|
type | failed | ✓ | Type of the state, always “failed” |
RevenueWithdrawalStatePending
The withdrawal is in progress.
| field | type | required | description |
|---|---|---|---|
type | pending | ✓ | Type of the state, always “pending” |
RevenueWithdrawalStateSucceeded
The withdrawal succeeded.
| field | type | required | description |
|---|---|---|---|
type | succeeded | ✓ | Type of the state, always “succeeded” |
date | integer | ✓ | Date the withdrawal was completed in Unix time |
url | string | ✓ | An HTTPS URL that can be used to see transaction details |
SentGuestMessage
Describes an inline message sent by a guest bot.
| field | type | required | description |
|---|---|---|---|
inline_message_id | string | ✓ | Identifier of the sent inline message |
SentWebAppMessage
Describes an inline message sent by a Web App on behalf of a user.
| field | type | required | description |
|---|---|---|---|
inline_message_id | string | Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. |
SharedUser
This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.
| field | type | required | description |
|---|---|---|---|
user_id | integer | ✓ | Identifier 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_name | string | Optional. First name of the user, if the name was requested by the bot | |
last_name | string | Optional. Last name of the user, if the name was requested by the bot | |
username | string | Optional. Username of the user, if the username was requested by the bot | |
photo | PhotoSize[] | Optional. Available sizes of the chat photo, if the photo was requested by the bot |
ShippingAddress
This object represents a shipping address.
| field | type | required | description |
|---|---|---|---|
country_code | string | ✓ | Two-letter ISO 3166-1 alpha-2 country code |
state | string | ✓ | State, if applicable |
city | string | ✓ | City |
street_line1 | string | ✓ | First line for the address |
street_line2 | string | ✓ | Second line for the address |
post_code | string | ✓ | Address post code |
ShippingOption
This object represents one shipping option.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Shipping option identifier |
title | string | ✓ | Option title |
prices | LabeledPrice[] | ✓ | List of price portions |
ShippingQuery
This object contains information about an incoming shipping query.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Unique query identifier |
from | User | ✓ | User who sent the query |
invoice_payload | string | ✓ | Bot-specified invoice payload |
shipping_address | ShippingAddress | ✓ | User specified shipping address |
StarAmount
Describes an amount of Telegram Stars.
| field | type | required | description |
|---|---|---|---|
amount | integer | ✓ | Integer amount of Telegram Stars, rounded to 0; can be negative |
nanostar_amount | integer | Optional. The number of 1/1000000000 shares of Telegram Stars; from -999999999 to 999999999; can be negative if and only if amount is non-positive |
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.
| field | type | required | description |
|---|---|---|---|
id | string | ✓ | Unique 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. |
amount | integer | ✓ | Integer amount of Telegram Stars transferred by the transaction |
nanostar_amount | integer | Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999 | |
date | integer | ✓ | Date the transaction was created in Unix time |
source | TransactionPartner | Optional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed withdrawal). Only for incoming transactions. | |
receiver | TransactionPartner | Optional. 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.
| field | type | required | description |
|---|---|---|---|
transactions | StarTransaction[] | ✓ | The list of transactions |
Sticker
This object represents a sticker.
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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. |
type | regular | mask | custom_emoji | ✓ | Type 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. |
width | integer | ✓ | Sticker width |
height | integer | ✓ | Sticker height |
is_animated | boolean | ✓ | True, if the sticker is animated |
is_video | boolean | ✓ | True, if the sticker is a video sticker |
thumbnail | PhotoSize | Optional. Sticker thumbnail in the .WEBP or .JPG format | |
emoji | string | Optional. Emoji associated with the sticker | |
set_name | string | Optional. Name of the sticker set to which the sticker belongs | |
premium_animation | File | Optional. For premium regular stickers, premium animation for the sticker | |
mask_position | MaskPosition | Optional. For mask stickers, the position where the mask should be placed | |
custom_emoji_id | string | Optional. For custom emoji stickers, unique identifier of the custom emoji | |
needs_repainting | true | Optional. 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_size | integer | Optional. File size in bytes |
StickerSet
This object represents a sticker set.
| field | type | required | description |
|---|---|---|---|
name | string | ✓ | Sticker set name |
title | string | ✓ | Sticker set title |
sticker_type | regular | mask | custom_emoji | ✓ | Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji” |
stickers | Sticker[] | ✓ | List of all set stickers |
thumbnail | PhotoSize | Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format |
Story
This object represents a story.
| field | type | required | description |
|---|---|---|---|
chat | Chat | ✓ | Chat that posted the story |
id | integer | ✓ | Unique identifier for the story in the chat |
StoryArea
Describes a clickable area on a story media.
| field | type | required | description |
|---|---|---|---|
position | StoryAreaPosition | ✓ | Position of the area |
type | StoryAreaType | ✓ | Type of the area |
StoryAreaPosition
Describes the position of a clickable area within a story.
| field | type | required | description |
|---|---|---|---|
x_percentage | float | ✓ | The abscissa of the area's center, as a percentage of the media width |
y_percentage | float | ✓ | The ordinate of the area's center, as a percentage of the media height |
width_percentage | float | ✓ | The width of the area's rectangle, as a percentage of the media width |
height_percentage | float | ✓ | The height of the area's rectangle, as a percentage of the media height |
rotation_angle | float | ✓ | The clockwise rotation angle of the rectangle, in degrees; 0-360 |
corner_radius_percentage | float | ✓ | The radius of the rectangle corner rounding, as a percentage of the media width |
StoryAreaType
Describes the type of a clickable area on a story. Currently, it can be one of
one of: StoryAreaTypeLocation, StoryAreaTypeSuggestedReaction, StoryAreaTypeLink, StoryAreaTypeWeather, StoryAreaTypeUniqueGift
StoryAreaTypeLink
Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.
| field | type | required | description |
|---|---|---|---|
type | link | ✓ | Type of the area, always “link” |
url | string | ✓ | HTTP or tg:// URL to be opened when the area is clicked |
StoryAreaTypeLocation
Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.
| field | type | required | description |
|---|---|---|---|
type | location | ✓ | Type of the area, always “location” |
latitude | float | ✓ | Location latitude in degrees |
longitude | float | ✓ | Location longitude in degrees |
address | LocationAddress | Optional. 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.
| field | type | required | description |
|---|---|---|---|
type | suggested_reaction | ✓ | Type of the area, always “suggested_reaction” |
reaction_type | ReactionType | ✓ | Type of the reaction |
is_dark | boolean | Optional. Pass True if the reaction area has a dark background | |
is_flipped | boolean | Optional. Pass True if reaction area corner is flipped |
StoryAreaTypeUniqueGift
Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.
| field | type | required | description |
|---|---|---|---|
type | unique_gift | ✓ | Type of the area, always “unique_gift” |
name | string | ✓ | Unique name of the gift |
StoryAreaTypeWeather
Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.
| field | type | required | description |
|---|---|---|---|
type | weather | ✓ | Type of the area, always “weather” |
temperature | float | ✓ | Temperature, in degree Celsius |
emoji | string | ✓ | Emoji representing the weather |
background_color | integer | ✓ | A color of the area background in the ARGB format |
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.
| field | type | required | description |
|---|---|---|---|
currency | string | ✓ | Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars |
total_amount | integer | ✓ | Total 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_payload | string | ✓ | Bot-specified invoice payload |
subscription_expiration_date | integer | Optional. Expiration date of the subscription, in Unix time; for recurring payments only | |
is_recurring | true | Optional. True, if the payment is a recurring payment for a subscription | |
is_first_recurring | true | Optional. True, if the payment is the first payment for a subscription | |
shipping_option_id | string | Optional. Identifier of the shipping option chosen by the user | |
order_info | OrderInfo | Optional. Order information provided by the user | |
telegram_payment_charge_id | string | ✓ | Telegram payment identifier |
provider_payment_charge_id | string | ✓ | Provider payment identifier |
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.
| field | type | required | description |
|---|---|---|---|
suggested_post_message | Message | Optional. 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. | |
price | SuggestedPostPrice | ✓ | Expected price of the post |
SuggestedPostApproved
Describes a service message about the approval of a suggested post.
| field | type | required | description |
|---|---|---|---|
suggested_post_message | Message | Optional. 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. | |
price | SuggestedPostPrice | Optional. Amount paid for the post | |
send_date | integer | ✓ | Date when the post will be published |
SuggestedPostDeclined
Describes a service message about the rejection of a suggested post.
| field | type | required | description |
|---|---|---|---|
suggested_post_message | Message | Optional. 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. | |
comment | string | Optional. Comment with which the post was declined |
SuggestedPostInfo
Contains information about a suggested post.
| field | type | required | description |
|---|---|---|---|
state | pending | approved | declined | ✓ | State of the suggested post. Currently, it can be one of “pending”, “approved”, “declined”. |
price | SuggestedPostPrice | Optional. Proposed price of the post. If the field is omitted, then the post is unpaid. | |
send_date | integer | Optional. 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. |
SuggestedPostPaid
Describes a service message about a successful payment for a suggested post.
| field | type | required | description |
|---|---|---|---|
suggested_post_message | Message | Optional. 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. | |
currency | string | ✓ | Currency in which the payment was made. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins. |
amount | integer | Optional. The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins only | |
star_amount | StarAmount | Optional. The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only |
SuggestedPostParameters
Contains parameters of a post that is being suggested by the bot.
| field | type | required | description |
|---|---|---|---|
price | SuggestedPostPrice | Optional. Proposed price for the post. If the field is omitted, then the post is unpaid. | |
send_date | integer | Optional. 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. |
SuggestedPostPrice
Describes the price of a suggested post.
| field | type | required | description |
|---|---|---|---|
currency | string | ✓ | Currency in which the post will be paid. Currently, must be one of “XTR” for Telegram Stars or “TON” for toncoins. |
amount | integer | ✓ | The 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. |
SuggestedPostRefunded
Describes a service message about a payment refund for a suggested post.
| field | type | required | description |
|---|---|---|---|
suggested_post_message | Message | Optional. 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. | |
reason | post_deleted | payment_refunded | ✓ | Reason 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. |
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.
| field | type | required | description |
|---|---|---|---|
query | string | Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted. | |
allow_user_chats | boolean | Optional. True, if private chats with users can be chosen | |
allow_bot_chats | boolean | Optional. True, if private chats with bots can be chosen | |
allow_group_chats | boolean | Optional. True, if group and supergroup chats can be chosen | |
allow_channel_chats | boolean | Optional. True, if channel chats can be chosen |
TextQuote
This object contains information about the quoted part of a message that is replied to by the given message.
| field | type | required | description |
|---|---|---|---|
text | string | ✓ | Text of the quoted part of a message that is replied to by the given message |
entities | MessageEntity[] | Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, custom_emoji, and date_time entities are kept in quotes. | |
position | integer | ✓ | Approximate quote position in the original message in UTF-16 code units as specified by the sender |
is_manual | true | Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server. |
TransactionPartner
This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be one of
one of: TransactionPartnerUser, TransactionPartnerChat, TransactionPartnerAffiliateProgram, TransactionPartnerFragment, TransactionPartnerTelegramAds, TransactionPartnerTelegramApi, TransactionPartnerOther
TransactionPartnerAffiliateProgram
Describes the affiliate program that issued the affiliate commission received via this transaction.
| field | type | required | description |
|---|---|---|---|
type | affiliate_program | ✓ | Type of the transaction partner, always “affiliate_program” |
sponsor_user | User | Optional. Information about the bot that sponsored the affiliate program | |
commission_per_mille | integer | ✓ | The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program sponsor from referred users |
TransactionPartnerChat
Describes a transaction with a chat.
| field | type | required | description |
|---|---|---|---|
type | chat | ✓ | Type of the transaction partner, always “chat” |
chat | Chat | ✓ | Information about the chat |
gift | Gift | Optional. The gift sent to the chat by the bot |
TransactionPartnerFragment
Describes a withdrawal transaction with Fragment.
| field | type | required | description |
|---|---|---|---|
type | fragment | ✓ | Type of the transaction partner, always “fragment” |
withdrawal_state | RevenueWithdrawalState | Optional. State of the transaction if the transaction is outgoing |
TransactionPartnerOther
Describes a transaction with an unknown source or recipient.
| field | type | required | description |
|---|---|---|---|
type | other | ✓ | Type of the transaction partner, always “other” |
TransactionPartnerTelegramAds
Describes a withdrawal transaction to the Telegram Ads platform.
| field | type | required | description |
|---|---|---|---|
type | telegram_ads | ✓ | Type of the transaction partner, always “telegram_ads” |
TransactionPartnerTelegramApi
Describes a transaction with payment for paid broadcasting.
| field | type | required | description |
|---|---|---|---|
type | telegram_api | ✓ | Type of the transaction partner, always “telegram_api” |
request_count | integer | ✓ | The number of successful requests that exceeded regular limits and were therefore billed |
TransactionPartnerUser
Describes a transaction with a user.
| field | type | required | description |
|---|---|---|---|
type | user | ✓ | Type of the transaction partner, always “user” |
transaction_type | invoice_payment | paid_media_payment | gift_purchase | premium_purchase | business_account_transfer | ✓ | Type 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 |
user | User | ✓ | Information about the user |
affiliate | AffiliateInfo | Optional. Information about the affiliate that received a commission via this transaction. Can be available only for “invoice_payment” and “paid_media_payment” transactions. | |
invoice_payload | string | Optional. Bot-specified invoice payload. Can be available only for “invoice_payment” transactions. | |
subscription_period | integer | Optional. The duration of the paid subscription. Can be available only for “invoice_payment” transactions. | |
paid_media | PaidMedia[] | Optional. Information about the paid media bought by the user; for “paid_media_payment” transactions only | |
paid_media_payload | string | Optional. Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions. | |
gift | Gift | Optional. The gift sent to the user by the bot; for “gift_purchase” transactions only | |
premium_subscription_duration | integer | Optional. Number of months the gifted Telegram Premium subscription will be active for; for “premium_purchase” transactions only |
UniqueGift
This object describes a unique gift that was upgraded from a regular gift.
| field | type | required | description |
|---|---|---|---|
gift_id | string | ✓ | Identifier of the regular gift from which the gift was upgraded |
base_name | string | ✓ | Human-readable name of the regular gift from which this unique gift was upgraded |
name | string | ✓ | Unique name of the gift. This name can be used in https://t.me/nft/... links and story areas. |
number | integer | ✓ | Unique number of the upgraded gift among gifts upgraded from the same regular gift |
model | UniqueGiftModel | ✓ | Model of the gift |
symbol | UniqueGiftSymbol | ✓ | Symbol of the gift |
backdrop | UniqueGiftBackdrop | ✓ | Backdrop of the gift |
is_premium | true | Optional. True, if the original regular gift was exclusively purchaseable by Telegram Premium subscribers | |
is_burned | true | Optional. True, if the gift was used to craft another gift and isn't available anymore | |
is_from_blockchain | true | Optional. True, if the gift is assigned from the TON blockchain and can't be resold or transferred in Telegram | |
colors | UniqueGiftColors | Optional. 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_chat | Chat | Optional. Information about the chat that published the gift |
UniqueGiftBackdrop
This object describes the backdrop of a unique gift.
| field | type | required | description |
|---|---|---|---|
name | string | ✓ | Name of the backdrop |
colors | UniqueGiftBackdropColors | ✓ | Colors of the backdrop |
rarity_per_mille | integer | ✓ | The number of unique gifts that receive this backdrop for every 1000 gifts upgraded |
UniqueGiftBackdropColors
This object describes the colors of the backdrop of a unique gift.
| field | type | required | description |
|---|---|---|---|
center_color | integer | ✓ | The color in the center of the backdrop in RGB format |
edge_color | integer | ✓ | The color on the edges of the backdrop in RGB format |
symbol_color | integer | ✓ | The color to be applied to the symbol in RGB format |
text_color | integer | ✓ | The color for the text on the backdrop in RGB format |
UniqueGiftColors
This object contains information about the color scheme for a user's name, message replies and link previews based on a unique gift.
| field | type | required | description |
|---|---|---|---|
model_custom_emoji_id | string | ✓ | Custom emoji identifier of the unique gift's model |
symbol_custom_emoji_id | string | ✓ | Custom emoji identifier of the unique gift's symbol |
light_theme_main_color | integer | ✓ | Main color used in light themes; RGB format |
light_theme_other_colors | integer[] | ✓ | List of 1-3 additional colors used in light themes; RGB format |
dark_theme_main_color | integer | ✓ | Main color used in dark themes; RGB format |
dark_theme_other_colors | integer[] | ✓ | List of 1-3 additional colors used in dark themes; RGB format |
UniqueGiftInfo
Describes a service message about a unique gift that was sent or received.
| field | type | required | description |
|---|---|---|---|
gift | UniqueGift | ✓ | Information about the gift |
origin | upgrade | transfer | resale | gifted_upgrade | offer | ✓ | Origin 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_currency | string | Optional. 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_amount | integer | Optional. For gifts bought from other users, the price paid for the gift in either Telegram Stars or nanotoncoins | |
owned_gift_id | string | Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of business accounts | |
transfer_star_count | integer | Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer the gift | |
next_transfer_date | integer | Optional. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift can be transferred now. |
UniqueGiftModel
This object describes the model of a unique gift.
| field | type | required | description |
|---|---|---|---|
name | string | ✓ | Name of the model |
sticker | Sticker | ✓ | The sticker that represents the unique gift |
rarity_per_mille | integer | ✓ | The number of unique gifts that receive this model for every 1000 gift upgrades. Always 0 for crafted gifts. |
rarity | uncommon | rare | epic | legendary | Optional. 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.
| field | type | required | description |
|---|---|---|---|
name | string | ✓ | Name of the symbol |
sticker | Sticker | ✓ | The sticker that represents the unique gift |
rarity_per_mille | integer | ✓ | The number of unique gifts that receive this model for every 1000 gifts upgraded |
Update
This object represents an incoming update.At most one of the optional fields can be present in any given update.
| field | type | required | description |
|---|---|---|---|
update_id | integer | ✓ | The 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. |
message | Message | Optional. New incoming message of any kind - text, photo, sticker, etc. | |
edited_message | Message | Optional. 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_post | Message | Optional. New incoming channel post of any kind - text, photo, sticker, etc. | |
edited_channel_post | Message | Optional. 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_connection | BusinessConnection | Optional. The bot was connected to or disconnected from a business account, or a user edited an existing connection with the bot | |
business_message | Message | Optional. New message from a connected business account | |
edited_business_message | Message | Optional. New version of a message from a connected business account | |
deleted_business_messages | BusinessMessagesDeleted | Optional. Messages were deleted from a connected business account | |
guest_message | Message | Optional. New guest message. The bot can use the field Message.guest_query_id and the method answerGuestQuery to send a message in response. | |
message_reaction | MessageReactionUpdated | Optional. 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_count | MessageReactionCountUpdated | Optional. 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_query | InlineQuery | Optional. New incoming inline query | |
chosen_inline_result | ChosenInlineResult | Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot. | |
callback_query | CallbackQuery | Optional. New incoming callback query | |
shipping_query | ShippingQuery | Optional. New incoming shipping query. Only for invoices with flexible price. | |
pre_checkout_query | PreCheckoutQuery | Optional. New incoming pre-checkout query. Contains full information about checkout. | |
purchased_paid_media | PaidMediaPurchased | Optional. A user purchased paid media with a non-empty payload sent by the bot in a non-channel chat | |
poll | Poll | Optional. New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot. | |
poll_answer | PollAnswer | Optional. 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_member | ChatMemberUpdated | Optional. 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_member | ChatMemberUpdated | Optional. 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_request | ChatJoinRequest | Optional. 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_boost | ChatBoostUpdated | Optional. A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates. | |
removed_chat_boost | ChatBoostRemoved | Optional. A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates. | |
managed_bot | ManagedBotUpdated | Optional. A new bot was created to be managed by the bot, or token or owner of a managed bot was changed |
User
This object represents a Telegram user or bot.
| field | type | required | description |
|---|---|---|---|
id | integer | ✓ | Unique 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_bot | boolean | ✓ | True, if this user is a bot |
first_name | string | ✓ | User's or bot's first name |
last_name | string | Optional. User's or bot's last name | |
username | string | Optional. User's or bot's username | |
language_code | string | Optional. IETF language tag of the user's language | |
is_premium | true | Optional. True, if this user is a Telegram Premium user | |
added_to_attachment_menu | true | Optional. True, if this user added the bot to the attachment menu | |
can_join_groups | boolean | Optional. True, if the bot can be invited to groups. Returned only in getMe. | |
can_read_all_group_messages | boolean | Optional. True, if privacy mode is disabled for the bot. Returned only in getMe. | |
supports_guest_queries | boolean | Optional. True, if the bot supports guest queries from chats it is not a member of. Returned only in getMe. | |
supports_inline_queries | boolean | Optional. True, if the bot supports inline queries. Returned only in getMe. | |
can_connect_to_business | boolean | Optional. True, if the bot can be connected to a user account to manage it. Returned only in getMe. | |
has_main_web_app | boolean | Optional. True, if the bot has a main Web App. Returned only in getMe. | |
has_topics_enabled | boolean | Optional. True, if the bot has forum topic mode enabled in private chats. Returned only in getMe. | |
allows_users_to_create_topics | boolean | Optional. True, if the bot allows users to create and delete topics in private chats. Returned only in getMe. | |
can_manage_bots | boolean | Optional. True, if other bots can be created to be controlled by the bot. Returned only in getMe. |
UserChatBoosts
This object represents a list of boosts added to a chat by a user.
| field | type | required | description |
|---|---|---|---|
boosts | ChatBoost[] | ✓ | The list of boosts added to the chat by the user |
UserProfileAudios
This object represents the audios displayed on a user's profile.
| field | type | required | description |
|---|---|---|---|
total_count | integer | ✓ | Total number of profile audios for the target user |
audios | Audio[] | ✓ | Requested profile audios |
UserProfilePhotos
This object represent a user's profile pictures.
| field | type | required | description |
|---|---|---|---|
total_count | integer | ✓ | Total number of profile pictures the target user has |
photos | PhotoSize[][] | ✓ | Requested profile pictures (in up to 4 sizes each) |
UserRating
This object describes the rating of a user based on their Telegram Star spendings.
| field | type | required | description |
|---|---|---|---|
level | integer | ✓ | Current 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. |
rating | integer | ✓ | Numerical value of the user's rating; the higher the rating, the better |
current_level_rating | integer | ✓ | The rating value required to get the current level |
next_level_rating | integer | Optional. The rating value required to get to the next level; omitted if the maximum level was reached |
UsersShared
This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.
| field | type | required | description |
|---|---|---|---|
request_id | integer | ✓ | Identifier of the request |
users | SharedUser[] | ✓ | Information about users shared with the bot |
Venue
This object represents a venue.
| field | type | required | description |
|---|---|---|---|
location | Location | ✓ | Venue location. Can't be a live location. |
title | string | ✓ | Name of the venue |
address | string | ✓ | Address of the venue |
foursquare_id | string | Optional. Foursquare identifier of the venue | |
foursquare_type | string | Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) | |
google_place_id | string | Optional. Google Places identifier of the venue | |
google_place_type | string | Optional. Google Places type of the venue. (See supported types.) |
Video
This object represents a video file.
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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. |
width | integer | ✓ | Video width as defined by the sender |
height | integer | ✓ | Video height as defined by the sender |
duration | integer | ✓ | Duration of the video in seconds as defined by the sender |
thumbnail | PhotoSize | Optional. Video thumbnail | |
cover | PhotoSize[] | Optional. Available sizes of the cover of the video in the message | |
start_timestamp | integer | Optional. Timestamp in seconds from which the video will play in the message | |
qualities | VideoQuality[] | Optional. List of available qualities of the video | |
file_name | string | Optional. Original filename as defined by the sender | |
mime_type | string | Optional. MIME type of the file as defined by the sender | |
file_size | integer | Optional. 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. |
VideoChatEnded
This object represents a service message about a video chat ended in the chat.
| field | type | required | description |
|---|---|---|---|
duration | integer | ✓ | Video chat duration in seconds |
VideoChatParticipantsInvited
This object represents a service message about new members invited to a video chat.
| field | type | required | description |
|---|---|---|---|
users | User[] | ✓ | New members that were invited to the video chat |
VideoChatScheduled
This object represents a service message about a video chat scheduled in the chat.
| field | type | required | description |
|---|---|---|---|
start_date | integer | ✓ | Point 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.
VideoNote
This object represents a video message (available in Telegram apps as of v.4.0).
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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. |
length | integer | ✓ | Video width and height (diameter of the video message) as defined by the sender |
duration | integer | ✓ | Duration of the video in seconds as defined by the sender |
thumbnail | PhotoSize | Optional. Video thumbnail | |
file_size | integer | Optional. File size in bytes |
VideoQuality
This object represents a video file of a specific quality.
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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. |
width | integer | ✓ | Video width |
height | integer | ✓ | Video height |
codec | string | ✓ | Codec that was used to encode the video, for example, “h264”, “h265”, or “av01” |
file_size | integer | Optional. 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. |
Voice
This object represents a voice note.
| field | type | required | description |
|---|---|---|---|
file_id | string | ✓ | Identifier for this file, which can be used to download or reuse the file |
file_unique_id | string | ✓ | Unique 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. |
duration | integer | ✓ | Duration of the audio in seconds as defined by the sender |
mime_type | string | Optional. MIME type of the file as defined by the sender | |
file_size | integer | Optional. 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. |
WebAppData
Describes data sent from a Web App to the bot.
| field | type | required | description |
|---|---|---|---|
data | string | ✓ | The data. Be aware that a bad client can send arbitrary data in this field. |
button_text | string | ✓ | Text 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. |
WebAppInfo
Describes a Web App.
| field | type | required | description |
|---|---|---|---|
url | string | ✓ | An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps |
WebhookInfo
Describes the current status of a webhook.
| field | type | required | description |
|---|---|---|---|
url | string | ✓ | Webhook URL, may be empty if webhook is not set up |
has_custom_certificate | boolean | ✓ | True, if a custom certificate was provided for webhook certificate checks |
pending_update_count | integer | ✓ | Number of updates awaiting delivery |
ip_address | string | Optional. Currently used webhook IP address | |
last_error_date | integer | Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook | |
last_error_message | string | Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook | |
last_synchronization_error_date | integer | Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters | |
max_connections | integer | Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery | |
allowed_updates | string[] | Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member, message_reaction, and message_reaction_count. |
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.
| field | type | required | description |
|---|---|---|---|
from_request | boolean | Optional. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess | |
web_app_name | string | Optional. Name of the Web App, if the access was granted when the Web App was launched from a link | |
from_attachment_menu | boolean | Optional. True, if the access was granted when the bot was added to the attachment or side menu |