description:"The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. 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 channel post that is known to the bot and was edited'
-
name:inline_query
types:
- InlineQuery
optional:true
description:'Optional. New incoming inline query'
-
name:chosen_inline_result
types:
- ChosenInlineResult
optional:true
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'
-
name:poll
types:
- Poll
optional:true
description:'Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot'
-
name:poll_answer
types:
- PollAnswer
optional:true
description:'Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.'
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:'Optional. True, if the bot can be invited to groups. Returned only in getMe.'
-
name:can_read_all_group_messages
types:
- bool
optional:true
description:'Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.'
-
name:supports_inline_queries
types:
- bool
optional:true
description:'Optional. True, if the bot supports inline queries. Returned only in getMe.'
extended_by:{}
-
name:Chat
description:'This object represents 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 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:photo
types:
- ChatPhoto
optional:true
description:'Optional. Chat photo. Returned only in getChat.'
-
name:bio
types:
- string
optional:true
description:'Optional. Bio of the other party in a private chat. Returned only in getChat.'
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. Returned only in getChat.'
description:'Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.'
description:'Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat.'
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. Returned only in getChat.'
-
name:location
types:
- ChatLocation
optional:true
description:'Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat.'
extended_by:{}
-
name:Message
description:'This object represents a message.'
fields:
-
name:message_id
types:
- int
optional:false
description:'Unique message identifier inside this chat'
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. For forwarded messages that were originally sent in channels or by an anonymous chat administrator, signature of the message sender if present'
description:'Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.'
-
name:via_bot
types:
- User
optional:true
description:'Optional. Bot through which the message was sent'
-
name:edit_date
types:
- int
optional:true
description:'Optional. Date the message was last edited in Unix time'
description:'Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text'
-
name:animation
types:
- Animation
optional:true
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'
-
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'
description:'Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption'
-
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: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.'
-
name:pinned_message
types:
- Message
optional:true
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 is itself a reply.'
-
name:invoice
types:
- Invoice
optional:true
description:'Optional. Message is an invoice for a payment, information about the invoice. More about payments »'
-
name:successful_payment
types:
- SuccessfulPayment
optional:true
description:'Optional. Message is a service message about a successful payment, information about the payment. More about payments »'
-
name:connected_website
types:
- string
optional:true
description:'Optional. The domain name of the website on which the user has logged in. More about Telegram Login »'
description:'Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker'
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:'____simple_html_dom__voku__html_wrapper____>Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emoji'
description:'This object contains information about one answer option in a poll.'
fields:
-
name:text
types:
- string
optional:false
description:'Option text, 1-100 characters'
-
name:voter_count
types:
- int
optional:false
description:'Number of users that voted for this option'
extended_by:{}
-
name:PollAnswer
description:'This object represents an answer of a user in a non-anonymous poll.'
fields:
-
name:poll_id
types:
- string
optional:false
description:'Unique poll identifier'
-
name:user
types:
- User
optional:false
description:'The user, who changed the answer to the poll'
-
name:option_ids
types:
- Array<int>
optional:false
description:'0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.'
extended_by:{}
-
name:Poll
description:'This object contains information about a poll.'
fields:
-
name:id
types:
- string
optional:false
description:'Unique poll identifier'
-
name:question
types:
- string
optional:false
description:'Poll question, 1-300 characters'
-
name:options
types:
- Array<PollOption>
optional:false
description:'List of poll options'
-
name:total_voter_count
types:
- int
optional:false
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.'
fields:
-
name:longitude
types:
- float
optional:false
description:'Longitude as defined by sender'
-
name:latitude
types:
- float
optional:false
description:'Latitude as defined by sender'
-
name:horizontal_accuracy
types:
- float
optional:true
description:'Optional. The radius of uncertainty for the location, measured in meters; 0-1500'
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:'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:"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 (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard."
description:'This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields web_app, request_contact, request_location, and request_poll are mutually exclusive.'
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 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.'
extended_by:{}
-
name:ReplyKeyboardRemove
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).'
fields:
-
name:remove_keyboard
types:
- bool
optional:false
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 (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and 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 ID without using a username, if this is allowed by their privacy settings.'
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.'
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.Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen."
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."
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.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:'Optional. Pass True to request the permission for your bot to send messages to the user.'
extended_by:{}
-
name:CallbackQuery
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.'
fields:
-
name:id
types:
- string
optional:false
description:'Unique identifier for this query'
-
name:from
types:
- User
optional:false
description:Sender
-
name:message
types:
- Message
optional:true
description:'Optional. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old'
-
name:inline_message_id
types:
- string
optional:true
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."
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 (has reply_to_message_id), 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, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege'
-
name:can_delete_messages
types:
- bool
optional:false
description:'True, if the administrator can delete messages of other users'
-
name:can_manage_video_chats
types:
- bool
optional:false
description:'True, if the administrator can manage video chats'
-
name:can_restrict_members
types:
- bool
optional:false
description:'True, if the administrator can restrict, ban or unban chat members'
-
name:can_promote_members
types:
- bool
optional:false
description:'True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user)'
-
name:can_change_info
types:
- bool
optional:false
description:'True, if the user is allowed to change the chat title, photo and other settings'
-
name:can_invite_users
types:
- bool
optional:false
description:'True, if the user is allowed to invite new users to the chat'
-
name:can_post_messages
types:
- bool
optional:true
description:'Optional. True, if the administrator can post in the channel; channels only'
-
name:can_edit_messages
types:
- bool
optional:true
description:'Optional. True, if the administrator can edit messages of other users and can pin messages; channels only'
-
name:can_pin_messages
types:
- bool
optional:true
description:'Optional. True, if the user is allowed to pin messages; groups and supergroups only'
description:'True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege'
-
name:can_delete_messages
types:
- bool
optional:false
description:'True, if the administrator can delete messages of other users'
description:'True, if the administrator can restrict, ban or unban chat members'
-
name:can_promote_members
types:
- bool
optional:false
description:'True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user)'
-
name:can_change_info
types:
- bool
optional:false
description:'True, if the user is allowed to change the chat title, photo and other settings'
-
name:can_invite_users
types:
- bool
optional:false
description:'True, if the user is allowed to invite new users to the chat'
-
name:can_post_messages
types:
- bool
optional:true
description:'Optional. True, if the administrator can post in the channel; channels only'
-
name:can_edit_messages
types:
- bool
optional:true
description:'Optional. True, if the administrator can edit messages of other users and can pin messages; channels only'
-
name:can_pin_messages
types:
- bool
optional:true
description:'Optional. True, if the user is allowed to pin messages; groups and supergroups only'
-
name:custom_title
types:
- string
optional:true
description:'Optional. Custom title for this user'
extended_by:{}
-
name:ChatMemberMember
description:'Represents a chat member that has no additional privileges or restrictions.'
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:'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:'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.'
extended_by:{}
-
name:InlineQuery
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:'Optional. Short description of the result'
-
name:thumb_url
types:
- string
optional:true
description:'Optional. Url of the thumbnail for the result'
-
name:thumb_width
types:
- int
optional:true
description:'Optional. Thumbnail width'
-
name:thumb_height
types:
- int
optional:true
description:'Optional. Thumbnail height'
extended_by:{}
-
name:InlineQueryResultPhoto
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. Short description of the result'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the photo 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 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. Caption of the GIF file to be sent, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the 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 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. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the 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 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. Caption of the video to be sent, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the video 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:video_width
types:
- int
optional:true
description:'Optional. Video width'
-
name:video_height
types:
- int
optional:true
description:'Optional. Video height'
-
name:video_duration
types:
- int
optional:true
description:'Optional. Video duration in seconds'
-
name:description
types:
- string
optional:true
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:'Unique identifier for this result, 1-64 Bytes'
-
name:latitude
types:
- float
optional:false
description:'Location latitude in degrees'
-
name:longitude
types:
- float
optional:false
description:'Location longitude in degrees'
-
name:title
types:
- string
optional:false
description:'Location title'
-
name:horizontal_accuracy
types:
- float
optional:true
description:'Optional. The radius of uncertainty for the location, measured in meters; 0-1500'
-
name:live_period
types:
- int
optional:true
description:'Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.'
-
name:heading
types:
- int
optional:true
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'
-
name:thumb_url
types:
- string
optional:true
description:'Optional. Url of the thumbnail for the result'
-
name:thumb_width
types:
- int
optional:true
description:'Optional. Thumbnail width'
-
name:thumb_height
types:
- int
optional:true
description:'Optional. Thumbnail height'
extended_by:{}
-
name:InlineQueryResultVenue
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'
-
name:thumb_url
types:
- string
optional:true
description:'Optional. Url of the thumbnail for the result'
-
name:thumb_width
types:
- int
optional:true
description:'Optional. Thumbnail width'
-
name:thumb_height
types:
- int
optional:true
description:'Optional. Thumbnail height'
extended_by:{}
-
name:InlineQueryResultContact
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:'Unique identifier for this result, 1-64 bytes'
-
name:photo_file_id
types:
- string
optional:false
description:'A valid file identifier of the photo'
-
name:title
types:
- string
optional:true
description:'Optional. Title for the result'
-
name:description
types:
- string
optional:true
description:'Optional. Short description of the result'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the photo 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 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:'Unique identifier for this result, 1-64 bytes'
-
name:gif_file_id
types:
- string
optional:false
description:'A valid file identifier for the GIF file'
-
name:title
types:
- string
optional:true
description:'Optional. Title for the result'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the 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 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. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the 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 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:'Unique identifier for this result, 1-64 bytes'
-
name:video_file_id
types:
- string
optional:false
description:'A valid file identifier for the video file'
-
name:title
types:
- string
optional:false
description:'Title for the result'
-
name:description
types:
- string
optional:true
description:'Optional. Short description of the result'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the video to be sent, 0-1024 characters after entities parsing'
-
name:parse_mode
types:
- string
optional:true
description:'Optional. Mode for parsing entities in the video 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 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'
-
name:disable_web_page_preview
types:
- bool
optional:true
description:'Optional. Disables link previews for links in the sent message'
extended_by:{}
-
name:InputLocationMessageContent
description:'Represents the content of a location message to be sent as the result of an inline query.'
fields:
-
name:latitude
types:
- float
optional:false
description:'Latitude of the location in degrees'
-
name:longitude
types:
- float
optional:false
description:'Longitude of the location in degrees'
-
name:horizontal_accuracy
types:
- float
optional:true
description:'Optional. The radius of uncertainty for the location, measured in meters; 0-1500'
-
name:live_period
types:
- int
optional:true
description:'Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.'
-
name:heading
types:
- int
optional:true
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:'Three-letter ISO 4217 currency code, see more on currencies'
-
name:prices
types:
- Array<LabeledPrice>
optional:false
description:'Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)'
-
name:max_tip_amount
types:
- int
optional:true
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'
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'
-
name:currency
types:
- string
optional:false
description:'Three-letter ISO 4217 currency code'
-
name:total_amount
types:
- int
optional:false
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:'This object represents one shipping option.'
fields:
-
name:id
types:
- string
optional:false
description:'Shipping option identifier'
-
name:title
types:
- string
optional:false
description:'Option title'
-
name:prices
types:
- Array<LabeledPrice>
optional:false
description:'List of price portions'
extended_by:{}
-
name:SuccessfulPayment
description:'This object contains basic information about a successful payment.'
fields:
-
name:currency
types:
- string
optional:false
description:'Three-letter ISO 4217 currency code'
-
name:total_amount
types:
- int
optional:false
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 contains information about an incoming shipping query.'
fields:
-
name:id
types:
- string
optional:false
description:'Unique query identifier'
-
name:from
types:
- User
optional:false
description:'User who sent the query'
-
name:invoice_payload
types:
- string
optional:false
description:'Bot specified invoice payload'
-
name:shipping_address
types:
- ShippingAddress
optional:false
description:'User specified shipping address'
extended_by:{}
-
name:PreCheckoutQuery
description:'This object contains information about an incoming pre-checkout query.'
fields:
-
name:id
types:
- string
optional:false
description:'Unique query identifier'
-
name:from
types:
- User
optional:false
description:'User who sent the query'
-
name:currency
types:
- string
optional:false
description:'Three-letter ISO 4217 currency code'
-
name:total_amount
types:
- int
optional:false
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:'Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.'
-
name:data
types:
- string
optional:true
description:'Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available 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 for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.'
-
name:front_side
types:
- PassportFile
optional:true
description:'Optional. Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.'
-
name:reverse_side
types:
- PassportFile
optional:true
description:'Optional. Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.'
-
name:selfie
types:
- PassportFile
optional:true
description:'Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.'
-
name:translation
types:
- Array<PassportFile>
optional:true
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.'
-
name:hash
types:
- string
optional:false
description:'Base64-encoded element hash for using in PassportElementErrorUnspecified'
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 forgotten.'
-
name:limit
types:
- int
optional:true
description:'Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.'
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 (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 (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 reply keyboard or to force a reply from the user.'
description:"Use this method to copy messages of any kind. Service 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 reply keyboard or to force a reply from the user.'
return_types:
- MessageId
-
name:sendPhoto
description:'Use this method to send photos. 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)'
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 reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendAudio
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."
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:'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 reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendDocument
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.'
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:'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 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 reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendAnimation
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.'
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:'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 reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendVoice
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 (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.'
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:'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 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 reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendMediaGroup
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.'
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:'Use this method to send point on the map. 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:latitude
types:
- float
optional:false
description:'Latitude of the location'
-
name:longitude
types:
- float
optional:false
description:'Longitude of the location'
-
name:horizontal_accuracy
types:
- float
optional:true
description:'The radius of uncertainty for the location, measured in meters; 0-1500'
-
name:live_period
types:
- int
optional:true
description:'Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.'
-
name:heading
types:
- int
optional:true
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 reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:editMessageLiveLocation
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'
-
name:latitude
types:
- float
optional:false
description:'Latitude of new location'
-
name:longitude
types:
- float
optional:false
description:'Longitude of new location'
-
name:horizontal_accuracy
types:
- float
optional:true
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.'
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.'
return_types:
- Message
- bool
-
name:sendVenue
description:'Use this method to send information about a venue. 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:latitude
types:
- float
optional:false
description:'Latitude of the venue'
-
name:longitude
types:
- float
optional:false
description:'Longitude of the venue'
-
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:'Foursquare identifier of the venue'
-
name:foursquare_type
types:
- string
optional:true
description:'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:'Google Places identifier of the venue'
-
name:google_place_type
types:
- string
optional:true
description:'Google Places type of the venue. (See supported types.)'
-
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 reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendContact
description:'Use this method to send phone contacts. 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)'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendPoll
description:'Use this method to send a native poll. 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:question
types:
- string
optional:false
description:'Poll question, 1-300 characters'
-
name:options
types:
- Array<string>
optional:false
description:'A JSON-serialized list of answer options, 2-10 strings 1-100 characters each'
-
name:is_anonymous
types:
- bool
optional:true
description:'True, if the poll needs to be anonymous, defaults to True'
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 reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendDice
description:'Use this method to send an animated emoji that will display a random value. 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)'
description:'____simple_html_dom__voku__html_wrapper____>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 reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendChatAction
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."
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: '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 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:'Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername)'
-
name:user_id
types:
- int
optional:false
description:'Unique identifier of the target user'
-
name:until_date
types:
- int
optional:true
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.'
-
name:revoke_messages
types:
- bool
optional:true
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:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
-
name:user_id
types:
- int
optional:false
description:'Unique identifier of the target user'
-
name:permissions
types:
- ChatPermissions
optional:false
description:'A JSON-serialized object for new user permissions'
-
name:until_date
types:
- int
optional:true
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, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups 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 he has promoted, directly or indirectly (promoted by administrators that were appointed by him)'
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:'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:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
return_types:
- bool
-
name:leaveChat
description:'Use this method for your bot to leave a group, supergroup or channel. 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 or channel (in the format @channelusername)'
return_types:
- bool
-
name:getChat
description:'Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.'
fields:
-
name:chat_id
types:
- int
- string
optional:false
description:'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)'
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:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
return_types:
- bool
-
name:answerCallbackQuery
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 change the list of the bot's commands. See https://core.telegram.org/bots#commands for more details about bot commands. 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 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 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 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:'Disables link previews for links in this message'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
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.'
return_types:
- Message
- bool
-
name:editMessageReplyMarkup
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.'
return_types:
- Poll
-
name:deleteMessage
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.- 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.'
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 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 reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:getStickerSet
description:'Use this method to get a sticker set. On success, a StickerSet object is returned.'
description:'Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.'
fields:
-
name:user_id
types:
- int
optional:false
description:'User identifier of sticker file owner'
description:'PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. More information on Sending Files »'
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. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. 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:'PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. 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 »'
description:'TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements'
-
name:webm_sticker
types:
- InputFile
optional:true
description:'WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements'
description:"Type of stickers in the set, pass “regular” or “mask”. Custom emoji sticker sets can't be created via the Bot API at the moment. By default, a regular sticker set is created."
description:'Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.'
description:'PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. 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 »'
description:'TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#animated-sticker-requirements for technical requirements'
-
name:webm_sticker
types:
- InputFile
optional:true
description:'WEBM video with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/stickers#video-sticker-requirements for technical requirements'
description:'Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.'
description:"A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the 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 sticker set thumbnails can't be uploaded via HTTP URL."
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:'If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter'
description:"Deep-linking parameter for the /start message sent to the bot when user presses the switch 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:'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:'Three-letter ISO 4217 currency code, see more on currencies'
-
name:prices
types:
- Array<LabeledPrice>
optional:false
description:'Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)'
-
name:max_tip_amount
types:
- int
optional:true
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'
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:'Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.'
-
name:provider_token
types:
- string
optional:false
description:'Payment provider token, obtained via BotFather'
-
name:currency
types:
- string
optional:false
description:'Three-letter ISO 4217 currency code, see more on currencies'
-
name:prices
types:
- Array<LabeledPrice>
optional:false
description:'Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)'
-
name:max_tip_amount
types:
- int
optional:true
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'
default:0
-
name:suggested_tip_amounts
types:
- Array<int>
optional:true
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.'
return_types:
- bool
-
name:setPassportDataErrors
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.'
fields:
-
name:chat_id
types:
- int
optional:false
description:'Unique identifier for the target chat'
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.'
