description:"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."
description:'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.'
description:'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.'
description:'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.'
description:'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.'
description:'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.'
-
name:callback_query
types:
- CallbackQuery
optional:true
description:'Optional. New incoming callback query'
-
name:shipping_query
types:
- ShippingQuery
optional:true
description:'Optional. New incoming shipping query. Only for invoices with flexible price'
-
name:pre_checkout_query
types:
- PreCheckoutQuery
optional:true
description:'Optional. New incoming pre-checkout query. Contains full information about checkout'
description:"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."
description:'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.'
description:'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.'
description:'Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member'
extended_by:{}
-
name:User
description:'This object represents a Telegram user or bot.'
fields:
-
name:id
types:
- int
optional:false
description:'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.'
description:'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.'
description:'Type of the chat, can be either “private”, “group”, “supergroup” or “channel”'
-
name:title
types:
- string
optional:true
description:'Optional. Title, for supergroups, channels and group chats'
-
name:username
types:
- string
optional:true
description:'Optional. Username, for private chats, supergroups and channels if available'
-
name:first_name
types:
- string
optional:true
description:'Optional. First name of the other party in a private chat'
-
name:last_name
types:
- string
optional:true
description:'Optional. Last name of the other party in a private chat'
-
name:is_forum
types:
- bool
optional:true
description:'Optional. True, if the supergroup chat is a forum (has topics enabled)'
default:true
extended_by:{}
-
name:ChatFullInfo
description:'This object contains full information about a chat.'
fields:
-
name:id
types:
- int
optional:false
description:'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.'
-
name:type
types:
- string
optional:false
description:'Type of the chat, can be either “private”, “group”, “supergroup” or “channel”'
description:'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.'
-
name:max_reaction_count
types:
- int
optional:false
description:'The maximum number of reactions that can be set on a message in the chat'
description:'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'
description:'Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by supergroup administrators'
description:'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'
description:"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."
description:'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.'
description:'Optional. Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.'
description:'Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.'
description:'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.'
description:'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.'
description:'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.'
-
name:external_reply
types:
- ExternalReplyInfo
optional:true
description:'Optional. Information about the message that is being replied to, which may come from another chat or forum topic'
-
name:quote
types:
- TextQuote
optional:true
description:'Optional. For replies that quote part of the original message, the quoted part of the message'
description:'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'
description:'Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set'
-
name:audio
types:
- Audio
optional:true
description:'Optional. Message is an audio file, information about the file'
-
name:document
types:
- Document
optional:true
description:'Optional. Message is a general file, information about the file'
-
name:photo
types:
- Array<PhotoSize>
optional:true
description:'Optional. Message is a photo, available sizes of the photo'
-
name:sticker
types:
- Sticker
optional:true
description:'Optional. Message is a sticker, information about the sticker'
description:'Optional. Message is a shared contact, information about the contact'
-
name:dice
types:
- Dice
optional:true
description:'Optional. Message is a dice with random value'
-
name:game
types:
- Game
optional:true
description:'Optional. Message is a game, information about the game. More about games »'
-
name:poll
types:
- Poll
optional:true
description:'Optional. Message is a native poll, information about the poll'
-
name:venue
types:
- Venue
optional:true
description:'Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set'
-
name:location
types:
- Location
optional:true
description:'Optional. Message is a shared location, information about the location'
-
name:new_chat_members
types:
- Array<User>
optional:true
description:'Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)'
-
name:left_chat_member
types:
- User
optional:true
description:'Optional. A member was removed from the group, information about them (this member may be the bot itself)'
-
name:new_chat_title
types:
- string
optional:true
description:'Optional. A chat title was changed to this value'
-
name:new_chat_photo
types:
- Array<PhotoSize>
optional:true
description:'Optional. A chat photo was change to this value'
-
name:delete_chat_photo
types:
- bool
optional:true
description: 'Optional. Service message:the chat photo was deleted'
description:"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."
description:"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."
description: 'Optional. Service message:auto-delete timer settings changed in the chat'
-
name:migrate_to_chat_id
types:
- int
optional:true
description:'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.'
-
name:migrate_from_chat_id
types:
- int
optional:true
description:'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.'
description:'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.'
description: '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'
description:'Length of the entity in UTF-16 code units'
-
name:url
types:
- string
optional:true
description:'Optional. For “text_link” only, URL that will be opened after user taps on the text'
-
name:user
types:
- User
optional:true
description:'Optional. For “text_mention” only, the mentioned user'
-
name:language
types:
- string
optional:true
description:'Optional. For “pre” only, the programming language of the entity text'
-
name:custom_emoji_id
types:
- string
optional:true
description:'Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker'
extended_by:{}
-
name:TextQuote
description:'This object contains information about the quoted part of a message that is replied to by the given message.'
fields:
-
name:text
types:
- string
optional:false
description:'Text of the quoted part of a message that is replied to by the given message'
-
name:entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes.'
-
name:position
types:
- int
optional:false
description:'Approximate quote position in the original message in UTF-16 code units as specified by the sender'
-
name:is_manual
types:
- bool
optional:true
description:'Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added automatically by the server.'
default:true
extended_by:{}
-
name:ExternalReplyInfo
description:'This object contains information about a message that is being replied to, which may come from another chat or forum topic.'
fields:
-
name:origin
types:
- MessageOrigin
optional:false
description:'Origin of the message replied to by the given message'
-
name:chat
types:
- Chat
optional:true
description:'Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel.'
-
name:message_id
types:
- int
optional:true
description:'Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup or a channel.'
-
name:link_preview_options
types:
- LinkPreviewOptions
optional:true
description:'Optional. Options used for link preview generation for the original message, if it is a text message'
-
name:animation
types:
- Animation
optional:true
description:'Optional. Message is an animation, information about the animation'
-
name:audio
types:
- Audio
optional:true
description:'Optional. Message is an audio file, information about the file'
-
name:document
types:
- Document
optional:true
description:'Optional. Message is a general file, information about the file'
-
name:photo
types:
- Array<PhotoSize>
optional:true
description:'Optional. Message is a photo, available sizes of the photo'
-
name:sticker
types:
- Sticker
optional:true
description:'Optional. Message is a sticker, information about the sticker'
-
name:story
types:
- Story
optional:true
description:'Optional. Message is a forwarded story'
-
name:video
types:
- Video
optional:true
description:'Optional. Message is a video, information about the video'
-
name:video_note
types:
- VideoNote
optional:true
description:'Optional. Message is a video note, information about the video message'
-
name:voice
types:
- Voice
optional:true
description:'Optional. Message is a voice message, information about the file'
-
name:has_media_spoiler
types:
- bool
optional:true
description:'Optional. True, if the message media is covered by a spoiler animation'
default:true
-
name:contact
types:
- Contact
optional:true
description:'Optional. Message is a shared contact, information about the contact'
-
name:dice
types:
- Dice
optional:true
description:'Optional. Message is a dice with random value'
-
name:game
types:
- Game
optional:true
description:'Optional. Message is a game, information about the game. More about games »'
-
name:giveaway
types:
- Giveaway
optional:true
description:'Optional. Message is a scheduled giveaway, information about the giveaway'
-
name:giveaway_winners
types:
- GiveawayWinners
optional:true
description:'Optional. A giveaway with public winners was completed'
-
name:invoice
types:
- Invoice
optional:true
description:'Optional. Message is an invoice for a payment, information about the invoice. More about payments »'
-
name:location
types:
- Location
optional:true
description:'Optional. Message is a shared location, information about the location'
-
name:poll
types:
- Poll
optional:true
description:'Optional. Message is a native poll, information about the poll'
-
name:venue
types:
- Venue
optional:true
description:'Optional. Message is a venue, information about the venue'
extended_by:{}
-
name:ReplyParameters
description:'Describes reply parameters for the message that is being sent.'
fields:
-
name:message_id
types:
- int
optional:false
description:'Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified'
description:'Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account.'
description:'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.'
description:"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, and custom_emoji entities. The message will fail to send if the quote isn't found in the original message."
-
name:quote_parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the quote. See formatting options for more details.'
-
name:quote_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of quote_parse_mode.'
-
name:quote_position
types:
- int
optional:true
description:'Optional. Position of the quote in the original message in UTF-16 code units'
extended_by:{}
-
name:MessageOrigin
description:'This object describes the origin of a message. It can be one of'
fields:{}
extended_by:
- MessageOriginUser
- MessageOriginHiddenUser
- MessageOriginChat
- MessageOriginChannel
-
name:MessageOriginUser
description:'The message was originally sent by a known user.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the message origin, always “user”'
-
name:date
types:
- int
optional:false
description:'Date the message was sent originally in Unix time'
-
name:sender_user
types:
- User
optional:false
description:'User that sent the message originally'
extended_by:{}
-
name:MessageOriginHiddenUser
description:'The message was originally sent by an unknown user.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the message origin, always “hidden_user”'
-
name:date
types:
- int
optional:false
description:'Date the message was sent originally in Unix time'
-
name:sender_user_name
types:
- string
optional:false
description:'Name of the user that sent the message originally'
extended_by:{}
-
name:MessageOriginChat
description:'The message was originally sent on behalf of a chat to a group chat.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the message origin, always “chat”'
-
name:date
types:
- int
optional:false
description:'Date the message was sent originally in Unix time'
-
name:sender_chat
types:
- Chat
optional:false
description:'Chat that sent the message originally'
-
name:author_signature
types:
- string
optional:true
description:'Optional. For messages originally sent by an anonymous chat administrator, original message author signature'
extended_by:{}
-
name:MessageOriginChannel
description:'The message was originally sent to a channel chat.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the message origin, always “channel”'
-
name:date
types:
- int
optional:false
description:'Date the message was sent originally in Unix time'
description:"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."
description:"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."
description:'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.'
description:"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."
description:'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.'
description:"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."
description:'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.'
description:"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."
description:'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.'
description:"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."
description:"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."
description:'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.'
description:"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."
description:'This object contains information about one answer option in a poll to send.'
fields:
-
name:text
types:
- string
optional:false
description:'Option text, 1-100 characters'
-
name:text_parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the text. See formatting options for more details. Currently, only custom emoji entities are allowed'
-
name:text_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. A JSON-serialized list of special entities that appear in the poll option text. It can be specified instead of text_parse_mode'
description:'Total number of users that voted in the poll'
-
name:is_closed
types:
- bool
optional:false
description:'True, if the poll is closed'
-
name:is_anonymous
types:
- bool
optional:false
description:'True, if the poll is anonymous'
-
name:type
types:
- string
optional:false
description:'Poll type, currently can be “regular” or “quiz”'
-
name:allows_multiple_answers
types:
- bool
optional:false
description:'True, if the poll allows multiple answers'
-
name:correct_option_id
types:
- int
optional:true
description:'Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.'
-
name:explanation
types:
- string
optional:true
description:'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'
-
name:explanation_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation'
-
name:open_period
types:
- int
optional:true
description:'Optional. Amount of time in seconds the poll will be active after creation'
-
name:close_date
types:
- int
optional:true
description:'Optional. Point in time (Unix timestamp) when the poll will be automatically closed'
extended_by:{}
-
name:Location
description:'This object represents a point on the map.'
description:'Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.'
description:'This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.'
fields:
-
name:traveler
types:
- User
optional:false
description:'User that triggered the alert'
-
name:watcher
types:
- User
optional:false
description:'User that set the alert'
-
name:distance
types:
- int
optional:false
description:'The distance between the users'
extended_by:{}
-
name:MessageAutoDeleteTimerChanged
description:'This object represents a service message about a change in auto-delete timer settings.'
description:'This object describes the way a background is filled based on the selected colors. Currently, it can be one of'
fields:{}
extended_by:
- BackgroundFillSolid
- BackgroundFillGradient
- BackgroundFillFreeformGradient
-
name:BackgroundFillSolid
description:'The background is filled using the selected color.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the background fill, always “solid”'
-
name:color
types:
- int
optional:false
description:'The color of the background fill in the RGB24 format'
extended_by:{}
-
name:BackgroundFillGradient
description:'The background is a gradient fill.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the background fill, always “gradient”'
-
name:top_color
types:
- int
optional:false
description:'Top color of the gradient in the RGB24 format'
-
name:bottom_color
types:
- int
optional:false
description:'Bottom color of the gradient in the RGB24 format'
-
name:rotation_angle
types:
- int
optional:false
description:'Clockwise rotation angle of the background fill in degrees; 0-359'
extended_by:{}
-
name:BackgroundFillFreeformGradient
description:'The background is a freeform gradient that rotates after every message in the chat.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the background fill, always “freeform_gradient”'
-
name:colors
types:
- Array<int>
optional:false
description:'A list of the 3 or 4 base colors that are used to generate the freeform gradient in the RGB24 format'
extended_by:{}
-
name:BackgroundType
description:'This object describes the type of a background. Currently, it can be one of'
fields:{}
extended_by:
- BackgroundTypeFill
- BackgroundTypeWallpaper
- BackgroundTypePattern
- BackgroundTypeChatTheme
-
name:BackgroundTypeFill
description:'The background is automatically filled based on the selected colors.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the background, always “fill”'
-
name:fill
types:
- BackgroundFill
optional:false
description:'The background fill'
-
name:dark_theme_dimming
types:
- int
optional:false
description:'Dimming of the background in dark themes, as a percentage; 0-100'
extended_by:{}
-
name:BackgroundTypeWallpaper
description:'The background is a wallpaper in the JPEG format.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the background, always “wallpaper”'
-
name:document
types:
- Document
optional:false
description:'Document with the wallpaper'
-
name:dark_theme_dimming
types:
- int
optional:false
description:'Dimming of the background in dark themes, as a percentage; 0-100'
-
name:is_blurred
types:
- bool
optional:true
description:'Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12'
default:true
-
name:is_moving
types:
- bool
optional:true
description:'Optional. True, if the background moves slightly when the device is tilted'
default:true
extended_by:{}
-
name:BackgroundTypePattern
description:'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.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the background, always “pattern”'
-
name:document
types:
- Document
optional:false
description:'Document with the pattern'
-
name:fill
types:
- BackgroundFill
optional:false
description:'The background fill that is combined with the pattern'
-
name:intensity
types:
- int
optional:false
description:'Intensity of the pattern when it is shown above the filled background; 0-100'
-
name:is_inverted
types:
- bool
optional:true
description:'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'
default:true
-
name:is_moving
types:
- bool
optional:true
description:'Optional. True, if the background moves slightly when the device is tilted'
default:true
extended_by:{}
-
name:BackgroundTypeChatTheme
description:'The background is taken directly from a built-in chat theme.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the background, always “chat_theme”'
-
name:theme_name
types:
- string
optional:false
description:'Name of the chat theme, which is usually an emoji'
extended_by:{}
-
name:ChatBackground
description:'This object represents a chat background.'
description:'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.'
-
name:first_name
types:
- string
optional:true
description:'Optional. First name of the user, if the name was requested by the bot'
-
name:last_name
types:
- string
optional:true
description:'Optional. Last name of the user, if the name was requested by the bot'
-
name:username
types:
- string
optional:true
description:'Optional. Username of the user, if the username was requested by the bot'
-
name:photo
types:
- Array<PhotoSize>
optional:true
description:'Optional. Available sizes of the chat photo, if the photo was requested by the bot'
description:'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.'
description:'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.'
description:'Optional. True, if the access was granted after the user accepted an explicit request from a Web App sent by the method requestWriteAccess'
description:'This object represents a service message about the creation of a scheduled giveaway. Currently holds no information.'
fields:{}
extended_by:{}
-
name:Giveaway
description:'This object represents a message about a scheduled giveaway.'
fields:
-
name:chats
types:
- Array<Chat>
optional:false
description:'The list of chats which the user must join to participate in the giveaway'
-
name:winners_selection_date
types:
- int
optional:false
description:'Point in time (Unix timestamp) when winners of the giveaway will be selected'
-
name:winner_count
types:
- int
optional:false
description:'The number of users which are supposed to be selected as winners of the giveaway'
-
name:only_new_members
types:
- bool
optional:true
description:'Optional. True, if only users who join the chats after the giveaway started should be eligible to win'
default:true
-
name:has_public_winners
types:
- bool
optional:true
description:'Optional. True, if the list of giveaway winners will be visible to everyone'
default:true
-
name:prize_description
types:
- string
optional:true
description:'Optional. Description of additional giveaway prize'
-
name:country_codes
types:
- Array<string>
optional:true
description:'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.'
-
name:premium_subscription_month_count
types:
- int
optional:true
description:'Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for'
extended_by:{}
-
name:GiveawayWinners
description:'This object represents a message about the completion of a giveaway with public winners.'
description:"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"
description:"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"
description:'Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown below the message text'
description:'Total number of profile pictures the target user has'
-
name:photos
types:
- Array<Array<PhotoSize>>
optional:false
description:'Requested profile pictures (in up to 4 sizes each)'
extended_by:{}
-
name:File
description:'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.'
fields:
-
name:file_id
types:
- string
optional:false
description:'Identifier for this file, which can be used to download or reuse the file'
description:"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."
description:'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.'
description:'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 Telegram Business account.'
description:'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.'
description:"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."
description:"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."
description:"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."
description:'This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text.'
description:'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.'
description:'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.'
description:'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.'
-
name:web_app
types:
- WebAppInfo
optional:true
description:'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.'
description:'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 »'
description:'Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no additional restrictions are applied.'
-
name:max_quantity
types:
- int
optional:true
description:'Optional. The maximum number of users to be selected; 1-10. Defaults to 1.'
description:'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 ».'
description:'Pass True to request a channel chat, pass False to request a group or a supergroup chat.'
-
name:chat_is_forum
types:
- bool
optional:true
description:'Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no additional restrictions are applied.'
-
name:chat_has_username
types:
- bool
optional:true
description:'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.'
-
name:chat_is_created
types:
- bool
optional:true
description:'Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.'
description:'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.'
description:'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.'
-
name:bot_is_member
types:
- bool
optional:true
description:'Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.'
description:'This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.'
fields:
-
name:type
types:
- string
optional:true
description:'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.'
description:'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 Telegram Business account.'
description:'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)'
description:"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."
description:'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.'
description:'Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes. Not supported for messages sent on behalf of a Telegram Business account.'
description:'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 Telegram Business account.'
description:"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 on behalf of a Telegram Business account."
description:"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 on behalf of a Telegram Business account."
description:"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 on behalf of a Telegram Business account."
description: '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.'
description:"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."
description:"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:\nTelegram apps support these buttons as of version 5.7."
description: '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.'
description:"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."
description:'This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.'
fields:
-
name:query
types:
- string
optional:true
description:"Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will be inserted"
-
name:allow_user_chats
types:
- bool
optional:true
description:'Optional. True, if private chats with users can be chosen'
-
name:allow_bot_chats
types:
- bool
optional:true
description:'Optional. True, if private chats with bots can be chosen'
-
name:allow_group_chats
types:
- bool
optional:true
description:'Optional. True, if group and supergroup chats can be chosen'
-
name:allow_channel_chats
types:
- bool
optional:true
description:'Optional. True, if channel chats can be chosen'
description:'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.'
description:'Optional. Identifier of the message sent via the bot in inline mode, that originated the query.'
-
name:chat_instance
types:
- string
optional:false
description:'Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.'
description:'Optional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.'
description:"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 Telegram Business account."
description:"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."
description:'This object represents a chat photo.'
fields:
-
name:small_file_id
types:
- string
optional:false
description:'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.'
description:"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."
description:'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.'
description:"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."
description:'Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999'
description:'True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.'
description:'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)'
description:"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"
description:'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'
description:'True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.'
description:'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)'
description:"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"
description:'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.'
description:"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"
description:"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"
description:'Type of the button, must be commands'
default:commands
extended_by:{}
-
name:MenuButtonWebApp
description:'Represents a menu button, which launches a Web App.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the button, must be web_app'
default:web_app
-
name:text
types:
- string
optional:false
description:'Text on the button'
-
name:web_app
types:
- WebAppInfo
optional:false
description:'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.'
extended_by:{}
-
name:MenuButtonDefault
description:'Describes that no specific value for the menu button was set.'
description:'This object describes the source of a chat boost. It can be one of'
fields:{}
extended_by:
- ChatBoostSourcePremium
- ChatBoostSourceGiftCode
- ChatBoostSourceGiveaway
-
name:ChatBoostSourcePremium
description:'The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user.'
fields:
-
name:source
types:
- string
optional:false
description:'Source of the boost, always “premium”'
-
name:user
types:
- User
optional:false
description:'User that boosted the chat'
extended_by:{}
-
name:ChatBoostSourceGiftCode
description:'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.'
fields:
-
name:source
types:
- string
optional:false
description:'Source of the boost, always “gift_code”'
-
name:user
types:
- User
optional:false
description:'User for which the gift code was created'
extended_by:{}
-
name:ChatBoostSourceGiveaway
description:'The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription.'
fields:
-
name:source
types:
- string
optional:false
description:'Source of the boost, always “giveaway”'
-
name:giveaway_message_id
types:
- int
optional:false
description:"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."
-
name:user
types:
- User
optional:true
description:'Optional. User that won the prize in the giveaway if any'
-
name:is_unclaimed
types:
- bool
optional:true
description:'Optional. True, if the giveaway was completed, but there was no user to win the prize'
default:true
extended_by:{}
-
name:ChatBoost
description:'This object contains information about a chat boost.'
fields:
-
name:boost_id
types:
- string
optional:false
description:'Unique identifier of the boost'
-
name:add_date
types:
- int
optional:false
description:'Point in time (Unix timestamp) when the chat was boosted'
-
name:expiration_date
types:
- int
optional:false
description:"Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged"
-
name:source
types:
- ChatBoostSource
optional:false
description:'Source of the added boost'
extended_by:{}
-
name:ChatBoostUpdated
description:'This object represents a boost added to a chat or changed.'
description:'Describes the connection of the bot with a business account.'
fields:
-
name:id
types:
- string
optional:false
description:'Unique identifier of the business connection'
-
name:user
types:
- User
optional:false
description:'Business account user that created the business connection'
-
name:user_chat_id
types:
- int
optional:false
description:'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.'
-
name:date
types:
- int
optional:false
description:'Date the connection was established in Unix time'
-
name:can_reply
types:
- bool
optional:false
description:'True, if the bot can act on behalf of the business account in chats that were active in the last 24 hours'
-
name:is_enabled
types:
- bool
optional:false
description:'True, if the connection is active'
extended_by:{}
-
name:BusinessMessagesDeleted
description:'This object is received when messages are deleted from a connected business account.'
fields:
-
name:business_connection_id
types:
- string
optional:false
description:'Unique identifier of the business connection'
-
name:chat
types:
- Chat
optional:false
description:'Information about a chat in the business account. The bot may not have access to the chat or the corresponding user.'
description:'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.'
-
name:retry_after
types:
- int
optional:true
description:'Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated'
extended_by:{}
-
name:InputMedia
description:'This object represents the content of a media message to be sent. It should be one of'
description:'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 »'
description:'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 »'
description:"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 »"
description:'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 »'
description:"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 »"
description:'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 »'
description:"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 »"
description:'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 »'
description:"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 »"
description:'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.'
description:'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.'
fields:{}
extended_by:{}
-
name:Sticker
description:'This object represents a sticker.'
fields:
-
name:file_id
types:
- string
optional:false
description:'Identifier for this file, which can be used to download or reuse the file'
description:"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."
-
name:type
types:
- string
optional:false
description:'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.'
description:'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'
description:'This object describes the position on faces where a mask should be placed by default.'
fields:
-
name:point
types:
- string
optional:false
description:'The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.'
-
name:x_shift
types:
- float
optional:false
description:'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.'
-
name:y_shift
types:
- float
optional:false
description:'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.'
-
name:scale
types:
- float
optional:false
description:'Mask scaling coefficient. For example, 2.0 means double size.'
description:"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, upload a new one using multipart/form-data, or pass “attach://<file_attach_name>” to upload a new one 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 »"
description:'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'
description:'List of 1-20 emoji associated with the sticker'
-
name:mask_position
types:
- MaskPosition
optional:true
description:'Optional. Position where the mask should be placed on faces. For “mask” stickers only.'
-
name:keywords
types:
- Array<string>
optional:true
description:'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.'
description:'This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.'
fields:
-
name:id
types:
- string
optional:false
description:'Unique identifier for this query'
-
name:from
types:
- User
optional:false
description:Sender
-
name:query
types:
- string
optional:false
description:'Text of the query (up to 256 characters)'
-
name:offset
types:
- string
optional:false
description:'Offset of the results to be returned, can be controlled by the bot'
description:'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'
description:'This object represents a button to be shown above inline query results. You must use exactly one of the optional fields.'
fields:
-
name:text
types:
- string
optional:false
description:'Label text on the button'
-
name:web_app
types:
- WebAppInfo
optional:true
description:'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.'
-
name:start_parameter
types:
- string
optional:true
description:"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."
description:'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.'
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the photo'
extended_by:{}
-
name:InlineQueryResultGif
description:'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.'
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the GIF animation'
extended_by:{}
-
name:InlineQueryResultMpeg4Gif
description:'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.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the result, must be mpeg4_gif'
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the video animation'
extended_by:{}
-
name:InlineQueryResultVideo
description:'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.'
description:'Optional. Short description of the result'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'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).'
extended_by:{}
-
name:InlineQueryResultAudio
description:'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.'
description:'Unique identifier for this result, 1-64 bytes'
-
name:audio_url
types:
- string
optional:false
description:'A valid URL for the audio file'
-
name:title
types:
- string
optional:false
description:Title
-
name:caption
types:
- string
optional:true
description:'Optional. Caption, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the audio caption. See formatting options for more details.'
-
name:caption_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name:performer
types:
- string
optional:true
description:'Optional. Performer'
-
name:audio_duration
types:
- int
optional:true
description:'Optional. Audio duration in seconds'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the audio'
extended_by:{}
-
name:InlineQueryResultVoice
description:'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.'
description:'Unique identifier for this result, 1-64 bytes'
-
name:voice_url
types:
- string
optional:false
description:'A valid URL for the voice recording'
-
name:title
types:
- string
optional:false
description:'Recording title'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.'
-
name:caption_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name:voice_duration
types:
- int
optional:true
description:'Optional. Recording duration in seconds'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the voice recording'
extended_by:{}
-
name:InlineQueryResultDocument
description:'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.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the result, must be document'
description:'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.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the result, must be location'
description:'Optional. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.'
description:'Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.'
-
name:proximity_alert_radius
types:
- int
optional:true
description:'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.'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the location'
description:'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.'
description:'Unique identifier for this result, 1-64 Bytes'
-
name:latitude
types:
- float
optional:false
description:'Latitude of the venue location in degrees'
-
name:longitude
types:
- float
optional:false
description:'Longitude of the venue location in degrees'
-
name:title
types:
- string
optional:false
description:'Title of the venue'
-
name:address
types:
- string
optional:false
description:'Address of the venue'
-
name:foursquare_id
types:
- string
optional:true
description:'Optional. Foursquare identifier of the venue if known'
-
name:foursquare_type
types:
- string
optional:true
description:'Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)'
-
name:google_place_id
types:
- string
optional:true
description:'Optional. Google Places identifier of the venue'
-
name:google_place_type
types:
- string
optional:true
description:'Optional. Google Places type of the venue. (See supported types.)'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the venue'
description:'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.'
description:'Unique identifier for this result, 1-64 bytes'
-
name:game_short_name
types:
- string
optional:false
description:'Short name of the game'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
extended_by:{}
-
name:InlineQueryResultCachedPhoto
description:'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.'
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the photo'
extended_by:{}
-
name:InlineQueryResultCachedGif
description:'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.'
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the GIF animation'
extended_by:{}
-
name:InlineQueryResultCachedMpeg4Gif
description:'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.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the result, must be mpeg4_gif'
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the video animation'
extended_by:{}
-
name:InlineQueryResultCachedSticker
description:'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.'
description:'Unique identifier for this result, 1-64 bytes'
-
name:sticker_file_id
types:
- string
optional:false
description:'A valid file identifier of the sticker'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the sticker'
extended_by:{}
-
name:InlineQueryResultCachedDocument
description:'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.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the result, must be document'
description:'Unique identifier for this result, 1-64 bytes'
-
name:title
types:
- string
optional:false
description:'Title for the result'
-
name:document_file_id
types:
- string
optional:false
description:'A valid file identifier for the file'
-
name:description
types:
- string
optional:true
description:'Optional. Short description of the result'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the document to be sent, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the document caption. See formatting options for more details.'
-
name:caption_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the file'
extended_by:{}
-
name:InlineQueryResultCachedVideo
description:'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.'
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the video'
extended_by:{}
-
name:InlineQueryResultCachedVoice
description:'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.'
description:'Unique identifier for this result, 1-64 bytes'
-
name:voice_file_id
types:
- string
optional:false
description:'A valid file identifier for the voice message'
-
name:title
types:
- string
optional:false
description:'Voice message title'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.'
-
name:caption_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the voice message'
extended_by:{}
-
name:InlineQueryResultCachedAudio
description:'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.'
description:'Unique identifier for this result, 1-64 bytes'
-
name:audio_file_id
types:
- string
optional:false
description:'A valid file identifier for the audio file'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the audio caption. See formatting options for more details.'
-
name:caption_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the audio'
extended_by:{}
-
name:InputMessageContent
description:'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:'
fields:{}
extended_by:
- InputTextMessageContent
- InputLocationMessageContent
- InputVenueMessageContent
- InputContactMessageContent
- InputInvoiceMessageContent
-
name:InputTextMessageContent
description:'Represents the content of a text message to be sent as the result of an inline query.'
fields:
-
name:message_text
types:
- string
optional:false
description:'Text of the message to be sent, 1-4096 characters'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the message text. See formatting options for more details.'
-
name:entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. List of special entities that appear in message text, which can be specified instead of parse_mode'
description:'Optional. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.'
description:'Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.'
-
name:proximity_alert_radius
types:
- int
optional:true
description:'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.'
extended_by:{}
-
name:InputVenueMessageContent
description:'Represents the content of a venue message to be sent as the result of an inline query.'
fields:
-
name:latitude
types:
- float
optional:false
description:'Latitude of the venue in degrees'
-
name:longitude
types:
- float
optional:false
description:'Longitude of the venue in degrees'
-
name:title
types:
- string
optional:false
description:'Name of the venue'
-
name:address
types:
- string
optional:false
description:'Address of the venue'
-
name:foursquare_id
types:
- string
optional:true
description:'Optional. Foursquare identifier of the venue, if known'
-
name:foursquare_type
types:
- string
optional:true
description:'Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)'
-
name:google_place_id
types:
- string
optional:true
description:'Optional. Google Places identifier of the venue'
-
name:google_place_type
types:
- string
optional:true
description:'Optional. Google Places type of the venue. (See supported types.)'
extended_by:{}
-
name:InputContactMessageContent
description:'Represents the content of a contact message to be sent as the result of an inline query.'
description:'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.'
description:'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.'
description:'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.'
-
name:provider_data
types:
- string
optional:true
description:'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.'
description:'Represents a result of an inline query that was chosen by the user and sent to their chat partner.'
fields:
-
name:result_id
types:
- string
optional:false
description:'The unique identifier for the result that was chosen'
-
name:from
types:
- User
optional:false
description:'The user that chose the result'
-
name:location
types:
- Location
optional:true
description:'Optional. Sender location, only for bots that require user location'
-
name:inline_message_id
types:
- string
optional:true
description:'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.'
-
name:query
types:
- string
optional:false
description:'The query that was used to obtain the result'
description:'This object represents a portion of the price for goods or services.'
fields:
-
name:label
types:
- string
optional:false
description:'Portion label'
-
name:amount
types:
- int
optional:false
description:'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).'
extended_by:{}
-
name:Invoice
description:'This object contains basic information about an invoice.'
fields:
-
name:title
types:
- string
optional:false
description:'Product name'
-
name:description
types:
- string
optional:false
description:'Product description'
-
name:start_parameter
types:
- string
optional:false
description:'Unique bot deep-linking parameter that can be used to generate this invoice'
description:'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).'
extended_by:{}
-
name:ShippingAddress
description:'This object represents a shipping address.'
description:'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).'
-
name:invoice_payload
types:
- string
optional:false
description:'Bot specified invoice payload'
-
name:shipping_option_id
types:
- string
optional:true
description:'Optional. Identifier of the shipping option chosen by the user'
description:'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).'
-
name:invoice_payload
types:
- string
optional:false
description:'Bot specified invoice payload'
-
name:shipping_option_id
types:
- string
optional:true
description:'Optional. Identifier of the shipping option chosen by the user'
description:"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."
description:"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."
description:'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.'
description:'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.'
description:'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.'
description:'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.'
description:'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.'
description:'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.'
description:'Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.'
description:"Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication"
description:'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:'
description:"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."
description:"The section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”"
description:'Name of the data field which has the error'
-
name:data_hash
types:
- string
optional:false
description:'Base64-encoded data hash'
-
name:message
types:
- string
optional:false
description:'Error message'
extended_by:{}
-
name:PassportElementErrorFrontSide
description:'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.'
description:"The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”"
description:'Base64-encoded hash of the file with the front side of the document'
-
name:message
types:
- string
optional:false
description:'Error message'
extended_by:{}
-
name:PassportElementErrorReverseSide
description:'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.'
description:"The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”"
description:"The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”"
description:"The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”"
description:'Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.'
fields:
-
name:source
types:
- string
optional:false
description:'Error source, must be translation_file'
description:"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”"
description:'Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.'
fields:
-
name:source
types:
- string
optional:false
description:'Error source, must be translation_files'
description:"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”"
description:'This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.'
fields:
-
name:title
types:
- string
optional:false
description:'Title of the game'
-
name:description
types:
- string
optional:false
description:'Description of the game'
-
name:photo
types:
- Array<PhotoSize>
optional:false
description:'Photo that will be displayed in the game message in chats.'
-
name:text
types:
- string
optional:true
description:'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.'
-
name:text_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.'
-
name:animation
types:
- Animation
optional:true
description:'Optional. Animation that will be displayed in the game message in chats. Upload via BotFather'
extended_by:{}
-
name:CallbackGame
description:'A placeholder, currently holds no information. Use BotFather to set up your game.'
fields:{}
extended_by:{}
-
name:GameHighScore
description:'This object represents one row of the high scores table for a game.'
fields:
-
name:position
types:
- int
optional:false
description:'Position in high score table for the game'
description:'Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will be forgotten.'
description:'Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.'
description:'A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn''t affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.'
description:"Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.\nIf you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content."
description:"The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput."
description:'A JSON-serialized list of the update types you want your bot to receive. For example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn''t affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.'
description:'A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.'
description:'Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.'
fields:
-
name:drop_pending_updates
types:
- bool
optional:true
description:'Pass True to drop all pending updates'
return_types:
- bool
-
name:getWebhookInfo
description:'Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.'
description:"A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object."
description:'Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.'
description:"Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters."
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:"Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned."
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:message_thread_id
types:
- int
optional:true
description:'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only'
-
name:from_chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)'
-
name:disable_notification
types:
- bool
optional:true
description:'Sends the message silently. Users will receive a notification with no sound.'
-
name:protect_content
types:
- bool
optional:true
description:'Protects the contents of the forwarded message from forwarding and saving'
-
name:message_id
types:
- int
optional:false
description:'Message identifier in the chat specified in from_chat_id'
description:"Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned."
description:'A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.'
description:"Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success."
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:"Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned."
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:message_thread_id
types:
- int
optional:true
description:'Unique identifier for the target message thread (topic) of the forum; for forum supergroups only'
-
name:from_chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)'
description:'A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.'
description:"Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »"
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:"Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.\nFor sending voice messages, use the sendVoice method instead."
description:'Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »'
description:"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 »"
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.'
description:'File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »'
description:"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 »"
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.'
description:'Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files »'
description:"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 »"
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.'
description:'Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files »'
description:"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 »"
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3 format, or in .M4A format (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.'
description:'Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.'
description:'Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported'
description:"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 »"
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.'
description:'Period in seconds during which the location will be updated (see Live Locations, should be between 60 and 86400, or 0x7FFFFFFF for live locations that can be edited indefinitely.'
description:'For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.'
-
name:proximity_alert_radius
types:
- int
optional:true
description:'For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.'
-
name:disable_notification
types:
- bool
optional:true
description:'Sends the message silently. Users will receive a notification with no sound.'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'0-based identifier of the correct answer option, required for polls in quiz mode'
-
name:explanation
types:
- string
optional:true
description:'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 with at most 2 line feeds after entities parsing'
-
name:explanation_parse_mode
types:
- string
optional:true
description:'Mode for parsing entities in the explanation. See formatting options for more details.'
description:"Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period."
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲”'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:"Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.\nWe only recommend using this method when a response from the bot will take a noticeable amount of time to arrive."
description: 'Type of action to broadcast. Choose one, depending on what the user is about to receive:typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.'
description:"Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns True on success."
description:'Identifier of the target message. If the message belongs to a media group, the reaction is set to the first non-deleted message in the group instead.'
description:'A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.'
description:'Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.'
description:'Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.'
description:'Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.'
description:'Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.'
description:"Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success."
description:'Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.'
description:'Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.'
description:'Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever'
description:'Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.'
description:'Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.'
description:'Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)'
description:"Pass 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"
description:"Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success."
description:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:sender_chat_id
types:
- int
optional:false
description:'Unique identifier of the target sender chat'
return_types:
- bool
-
name:unbanChatSenderChat
description:'Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:sender_chat_id
types:
- int
optional:false
description:'Unique identifier of the target sender chat'
description:'Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.'
description:'Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.'
description:'Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.'
description:'Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.'
description:'Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.'
description:'Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.'
description:'Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:user_id
types:
- int
optional:false
description:'Unique identifier of the target user'
return_types:
- bool
-
name:declineChatJoinRequest
description:'Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:user_id
types:
- int
optional:false
description:'Unique identifier of the target user'
description:"Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
description:"Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
description:"Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
description:'Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.'
description:"Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success."
description:'Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.'
description:"Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success."
description:"Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success."
description:'Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success.'
description:'Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.'
description:'Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.'
description:'Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.'
fields:{}
return_types:
- Array<Sticker>
-
name:createForumTopic
description:'Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
description:'Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)'
description:'Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.'
return_types:
- ForumTopic
-
name:editForumTopic
description:'Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
-
name:message_thread_id
types:
- int
optional:false
description:'Unique identifier for the target message thread of the forum topic'
description:'New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept'
description:'Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
-
name:message_thread_id
types:
- int
optional:false
description:'Unique identifier for the target message thread of the forum topic'
return_types:
- bool
-
name:reopenForumTopic
description:'Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
-
name:message_thread_id
types:
- int
optional:false
description:'Unique identifier for the target message thread of the forum topic'
return_types:
- bool
-
name:deleteForumTopic
description:'Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
-
name:message_thread_id
types:
- int
optional:false
description:'Unique identifier for the target message thread of the forum topic'
return_types:
- bool
-
name:unpinAllForumTopicMessages
description:'Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
-
name:message_thread_id
types:
- int
optional:false
description:'Unique identifier for the target message thread of the forum topic'
description:"Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success."
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
-
name:name
types:
- string
optional:false
description:'New topic name, 1-128 characters'
return_types:
- bool
-
name:closeGeneralForumTopic
description:"Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success."
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
return_types:
- bool
-
name:reopenGeneralForumTopic
description:"Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success."
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
return_types:
- bool
-
name:hideGeneralForumTopic
description:"Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success."
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
return_types:
- bool
-
name:unhideGeneralForumTopic
description:"Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success."
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
description:'Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
description:'Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.'
fields:
-
name:callback_query_id
types:
- string
optional:false
description:'Unique identifier for the query to be answered'
-
name:text
types:
- string
optional:true
description:'Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters'
description:"URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your game - note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter."
description:'The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.'
description:'Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the chat or username of the channel (in the format @channelusername)'
-
name:user_id
types:
- int
optional:false
description:'Unique identifier of the target user'
description:'Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.'
fields:
-
name:business_connection_id
types:
- string
optional:false
description:'Unique identifier of the business connection'
description:'A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands'
description:"Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success."
description:'A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands'
description:"Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned."
description:"Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success."
fields:
-
name:description
types:
- string
optional:true
description:'New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.'
-
name:language_code
types:
- string
optional:true
description:'A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.'
return_types:
- bool
-
name:getMyDescription
description:'Use this method to get the current bot description for the given user language. Returns BotDescription on success.'
fields:
-
name:language_code
types:
- string
optional:true
description:'A two-letter ISO 639-1 language code or an empty string'
return_types:
- BotDescription
-
name:setMyShortDescription
description:"Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success."
fields:
-
name:short_description
types:
- string
optional:true
description:'New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.'
-
name:language_code
types:
- string
optional:true
description:'A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.'
return_types:
- bool
-
name:getMyShortDescription
description:'Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.'
fields:
-
name:language_code
types:
- string
optional:true
description:'A two-letter ISO 639-1 language code or an empty string'
description:"Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success."
description:"Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success."
description:'A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.'
-
name:for_channels
types:
- bool
optional:true
description:'Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.'
return_types:
- bool
-
name:getMyDefaultAdministratorRights
description:'Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.'
fields:
-
name:for_channels
types:
- bool
optional:true
description:'Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.'
description:'Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.'
fields:
-
name:chat_id
types:
- int
- string
optional:true
description:'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:message_id
types:
- int
optional:true
description:'Required if inline_message_id is not specified. Identifier of the message to edit'
-
name:inline_message_id
types:
- string
optional:true
description:'Required if chat_id and message_id are not specified. Identifier of the inline message'
-
name:text
types:
- string
optional:false
description:'New text of the message, 1-4096 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Mode for parsing entities in the message text. See formatting options for more details.'
description:'A JSON-serialized object for an inline keyboard.'
return_types:
- Message
- bool
-
name:editMessageCaption
description:'Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.'
fields:
-
name:chat_id
types:
- int
- string
optional:true
description:'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:message_id
types:
- int
optional:true
description:'Required if inline_message_id is not specified. Identifier of the message to edit'
-
name:inline_message_id
types:
- string
optional:true
description:'Required if chat_id and message_id are not specified. Identifier of the inline message'
-
name:caption
types:
- string
optional:true
description:'New caption of the message, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Mode for parsing entities in the message caption. See formatting options for more details.'
description:"Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned."
description:'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:message_id
types:
- int
optional:true
description:'Required if inline_message_id is not specified. Identifier of the message to edit'
-
name:inline_message_id
types:
- string
optional:true
description:'Required if chat_id and message_id are not specified. Identifier of the inline message'
-
name:media
types:
- InputMedia
optional:false
description:'A JSON-serialized object for a new media content of the message'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'A JSON-serialized object for a new inline keyboard.'
description:'Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.'
fields:
-
name:chat_id
types:
- int
- string
optional:true
description:'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:message_id
types:
- int
optional:true
description:'Required if inline_message_id is not specified. Identifier of the message to edit'
-
name:inline_message_id
types:
- string
optional:true
description:'Required if chat_id and message_id are not specified. Identifier of the inline message'
description:'New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged'
description:'The radius of uncertainty for the location, measured in meters; 0-1500'
-
name:heading
types:
- int
optional:true
description:'Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.'
-
name:proximity_alert_radius
types:
- int
optional:true
description:'The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'A JSON-serialized object for a new inline keyboard.'
return_types:
- Message
- bool
-
name:stopMessageLiveLocation
description:'Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.'
fields:
-
name:chat_id
types:
- int
- string
optional:true
description:'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:message_id
types:
- int
optional:true
description:'Required if inline_message_id is not specified. Identifier of the message with live location to stop'
-
name:inline_message_id
types:
- string
optional:true
description:'Required if chat_id and message_id are not specified. Identifier of the inline message'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'A JSON-serialized object for a new inline keyboard.'
description:'Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.'
fields:
-
name:chat_id
types:
- int
- string
optional:true
description:'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:message_id
types:
- int
optional:true
description:'Required if inline_message_id is not specified. Identifier of the message to edit'
-
name:inline_message_id
types:
- string
optional:true
description:'Required if chat_id and message_id are not specified. Identifier of the inline message'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'A JSON-serialized object for an inline keyboard.'
return_types:
- Message
- bool
-
name:stopPoll
description:'Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
-
name:message_id
types:
- int
optional:false
description:'Identifier of the original message with the poll'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'A JSON-serialized object for a new message inline keyboard.'
description:"Use this method to delete a message, including service messages, with the following limitations:- A message can only be deleted if it was sent less than 48 hours ago.- Service messages about a supergroup, channel, or forum topic creation can't be deleted.- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.- Bots can delete outgoing messages in private chats, groups, and supergroups.- Bots can delete incoming messages in private chats.- Bots granted can_post_messages permissions can delete outgoing messages in channels.- If the bot is an administrator of a group, it can delete any message there.- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.Returns True on success."
description:"Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success."
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
description:"Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP sticker from the Internet, or upload a new .WEBP, .TGS, or .WEBM sticker using multipart/form-data. More information on Sending Files ». Video and animated stickers can't be sent via an HTTP URL."
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user'
description:'Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.'
description:'A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files »'
-
name:sticker_format
types:
- string
optional:false
description:'Format of the sticker, must be one of “static”, “animated”, “video”'
description:'Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.'
description:'Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, digits and underscores. Must begin with a letter, can''t contain consecutive underscores and must end in "_by_<bot_username>". <bot_username> is case insensitive. 1-64 characters.'
description:'Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only'
description:'Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.'
description:"A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed."
return_types:
- bool
-
name:setStickerPositionInSet
description:'Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.'
description:'Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.'
fields:
-
name:user_id
types:
- int
optional:false
description:'User identifier of the sticker set owner'
-
name:name
types:
- string
optional:false
description:'Sticker set name'
-
name:old_sticker
types:
- string
optional:false
description:'File identifier of the replaced sticker'
-
name:sticker
types:
- InputSticker
optional:false
description:'A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.'
description:'Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.'
description:'Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.'
description:'Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.'
description:'Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.'
description:"A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail."
description:'Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.'
fields:
-
name:name
types:
- string
optional:false
description:'Sticker set name'
-
name:custom_emoji_id
types:
- string
optional:true
description:'Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.'
return_types:
- bool
-
name:deleteStickerSet
description:'Use this method to delete a sticker set that was created by the bot. Returns True on success.'
description:'Pass True if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.'
description:"Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don't support pagination. Offset length can't exceed 64 bytes."
description:'Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.'
fields:
-
name:web_app_query_id
types:
- string
optional:false
description:'Unique identifier for the query to be answered'
-
name:result
types:
- InlineQueryResult
optional:false
description:'A JSON-serialized object describing the message to be sent'
description:'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.'
description:'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.'
description:'A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.'
-
name:start_parameter
types:
- string
optional:true
description:'Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter'
description:'JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.'
description:'URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.'
description:"A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button."
description:'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.'
description:'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.'
description:'A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.'
-
name:provider_data
types:
- string
optional:true
description:'JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.'
-
name:photo_url
types:
- string
optional:true
description:'URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.'
description:'If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.'
fields:
-
name:shipping_query_id
types:
- string
optional:false
description:'Unique identifier for the query to be answered'
description:'Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)'
description:'Required if ok is True. A JSON-serialized array of available shipping options.'
-
name:error_message
types:
- string
optional:true
description:'Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is unavailable''). Telegram will display this message to the user.'
return_types:
- bool
-
name:answerPreCheckoutQuery
description: 'Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note:The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.'
fields:
-
name:pre_checkout_query_id
types:
- string
optional:false
description:'Unique identifier for the query to be answered'
-
name:ok
types:
- bool
optional:false
description:'Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems.'
-
name:error_message
types:
- string
optional:true
description:'Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.'
description:"Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.\nUse this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues."
fields:
-
name:user_id
types:
- int
optional:false
description:'User identifier'
-
name:errors
types:
- Array<PassportElementError>
optional:false
description:'A JSON-serialized array describing the errors'
return_types:
- bool
-
name:sendGame
description:'Use this method to send a game. On success, the sent Message is returned.'
description:"A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game."
description:"Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False."
description:'Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.'