--- name: Telegram Bot API children: - name: Recent changes children: - name: March 30, 2020 children: [] desc: - name: p content: Bot API 4.7 - name: ul content: - Added the method sendDice for sending a dice message, which will have a random value from 1 to 6. (Yes, we're aware of the “proper” singular of die. But it's awkward, and we decided to help it change. One dice at a time!) - Added the field dice to the Message object. - Added the method getMyCommands for getting the current list of the bot's commands. - Added the method setMyCommands for changing the list of the bot's commands through the Bot API instead of @BotFather. - Added the ability to create animated sticker sets by specifying the parameter tgs_sticker instead of png_sticker in the method createNewStickerSet. - Added the ability to add animated stickers to sets created by the bot by specifying the parameter tgs_sticker instead of png_sticker in the method addStickerToSet. - Added the field thumb to the StickerSet object. - Added the ability to change thumbnails of sticker sets created by the bot using the method setStickerSetThumb. - name: January 23, 2020 children: [] desc: - name: p content: Bot API 4.6 - name: ul content: - Supported Polls 2.0. - 'Added the ability to send non-anonymous, multiple answer, and quiz-style polls: added the parameters is_anonymous, type, allows_multiple_answers, correct_option_id, is_closed options to the method sendPoll.' - Added the object KeyboardButtonPollType and the field request_poll to the object KeyboardButton. - Added updates about changes of user answers in non-anonymous polls, represented by the object PollAnswer and the field poll_answer in the Update object. - Added the fields total_voter_count, is_anonymous, type, allows_multiple_answers, correct_option_id to the Poll object. - Bots can now send polls to private chats. - 'Added more information about the bot in response to the getMe request: added the fields can_join_groups, can_read_all_group_messages and supports_inline_queries to the User object.' - Added the optional field language to the MessageEntity object. - name: December 31, 2019 children: [] desc: - name: p content: Bot API 4.5 - name: ul content: - Added support for two new MessageEntity types, underline and strikethrough. - Added support for nested MessageEntity objects. Entities can now contain other entities. If two entities have common characters then one of them is fully contained inside the other. - Added support for nested entities and the new tags / (for underlined text) and // (for strikethrough text) in parse mode HTML. - Added a new parse mode, MarkdownV2, which supports nested entities and two new entities __ (for underlined text) and ~ (for strikethrough text). Parse mode Markdown remains unchanged for backward compatibility. - Added the field file_unique_id to the objects Animation, Audio, Document, PassportFile, PhotoSize, Sticker, Video, VideoNote, Voice, File and the fields small_file_unique_id and big_file_unique_id to the object ChatPhoto. The new fields contain a unique file identifier, which is supposed to be the same over time and for different bots, but can't be used to download or reuse the file. - Added the field custom_title to the ChatMember object. - Added the new method setChatAdministratorCustomTitle to manage the custom titles of administrators promoted by the bot. - Added the field slow_mode_delay to the Chat object. - name: p content: See earlier changes » desc: - name: blockquote content: Subscribe to @BotNews to be the first to know about the latest updates and join the discussion in @BotTalk - name: Authorizing your bot children: [] desc: - name: p content: Each bot is given a unique authentication token when it is created. The token looks something like 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11, but we'll use simply in this document instead. You can learn about obtaining tokens and generating new ones in this document. - name: Making requests children: - name: Making requests when getting updates children: [] desc: - name: p content: If you're using webhooks, you can perform a request to the Bot API while sending an answer to the webhook. Use either application/json or application/x-www-form-urlencoded or multipart/form-data response content type for passing parameters. Specify the method to be invoked in the method parameter of the request. It's not possible to know that such a request was successful or get its result. - name: blockquote content: Please see our FAQ for examples. desc: - name: p content: 'All queries to the Telegram Bot API must be served over HTTPS and need to be presented in this form: https://api.telegram.org/bot/METHOD_NAME. Like this for example:' - name: pre content: https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/getMe - name: p content: 'We support GET and POST HTTP methods. We support four ways of passing parameters in Bot API requests:' - name: ul content: - URL query string - application/x-www-form-urlencoded - application/json (except for uploading files) - multipart/form-data (use to upload files) - name: p content: The response contains a JSON object, which always has a Boolean field ‘ok’ and may have an optional String field ‘description’ with a human-readable description of the result. If ‘ok’ equals true, the request was successful and the result of the query can be found in the ‘result’ field. In case of an unsuccessful request, ‘ok’ equals false and the error is explained in the ‘description’. An Integer ‘error_code’ field is also returned, but its contents are subject to change in the future. Some errors may also have an optional field ‘parameters’ of the type ResponseParameters, which can help to automatically handle the error. - name: ul content: - All methods in the Bot API are case-insensitive. - All queries must be made using UTF-8. - name: Getting updates children: - name: Update children: [] desc: - name: p content: This object represents an incoming update.At most one of the optional parameters can be present in any given update. table: - Field: update_id Type: Integer 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. - Field: message Type: Message Description: Optional. New incoming message of any kind — text, photo, sticker, etc. - Field: edited_message Type: Message Description: Optional. New version of a message that is known to the bot and was edited - Field: channel_post Type: Message Description: Optional. New incoming channel post of any kind — text, photo, sticker, etc. - Field: edited_channel_post Type: Message Description: Optional. New version of a channel post that is known to the bot and was edited - Field: inline_query Type: InlineQuery Description: Optional. New incoming inline query - Field: chosen_inline_result Type: ChosenInlineResult 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. - Field: callback_query Type: CallbackQuery Description: Optional. New incoming callback query - Field: shipping_query Type: ShippingQuery Description: Optional. New incoming shipping query. Only for invoices with flexible price - Field: pre_checkout_query Type: PreCheckoutQuery Description: Optional. New incoming pre-checkout query. Contains full information about checkout - Field: poll Type: Poll Description: Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot - Field: poll_answer Type: PollAnswer 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. - name: getUpdates children: [] desc: - name: p content: Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned. - name: blockquote content: Notes1. This method will not work if an outgoing webhook is set up.2. In order to avoid getting duplicate updates, recalculate offset after each server response. table: - Parameter: offset Type: Integer Required: Optional 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. - Parameter: limit Type: Integer Required: Optional Description: Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100. - Parameter: timeout Type: Integer Required: Optional 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. - Parameter: allowed_updates Type: Array of String Required: Optional 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 updates regardless of type (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. - name: setWebhook children: [] desc: - name: p content: 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. - name: p content: If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/. Since nobody else knows your bot‘s token, you can be pretty sure it’s us. - name: blockquote content: |- Notes1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.3. Ports currently supported for Webhooks: 443, 80, 88, 8443. NEW! If you're having any trouble setting up webhooks, please check out this amazing guide to Webhooks. table: - Parameter: url Type: String Required: 'Yes' Description: HTTPS url to send updates to. Use an empty string to remove webhook integration - Parameter: certificate Type: InputFile Required: Optional Description: Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details. - Parameter: max_connections Type: Integer Required: Optional Description: 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. - Parameter: allowed_updates Type: Array of String Required: Optional 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 updates regardless of type (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. - name: deleteWebhook children: [] desc: - name: p content: Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters. - name: getWebhookInfo children: [] desc: - name: p content: 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. - name: WebhookInfo children: [] desc: - name: p content: Contains information about the current status of a webhook. table: - Field: url Type: String Description: Webhook URL, may be empty if webhook is not set up - Field: has_custom_certificate Type: Boolean Description: True, if a custom certificate was provided for webhook certificate checks - Field: pending_update_count Type: Integer Description: Number of updates awaiting delivery - Field: last_error_date Type: Integer Description: Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook - Field: last_error_message Type: String Description: Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook - Field: max_connections Type: Integer Description: Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery - Field: allowed_updates Type: Array of String Description: Optional. A list of update types the bot is subscribed to. Defaults to all update types desc: - name: p content: There are two mutually exclusive ways of receiving updates for your bot — the getUpdates method on one hand and Webhooks on the other. Incoming updates are stored on the server until the bot receives them either way, but they will not be kept longer than 24 hours. - name: p content: Regardless of which option you choose, you will receive JSON-serialized Update objects as a result. - name: Available types children: - name: User children: [] desc: - name: p content: This object represents a Telegram user or bot. table: - Field: id Type: Integer Description: Unique identifier for this user or bot - Field: is_bot Type: Boolean Description: True, if this user is a bot - Field: first_name Type: String Description: User‘s or bot’s first name - Field: last_name Type: String Description: Optional. User‘s or bot’s last name - Field: username Type: String Description: Optional. User‘s or bot’s username - Field: language_code Type: String Description: Optional. IETF language tag of the user's language - Field: can_join_groups Type: Boolean Description: Optional. True, if the bot can be invited to groups. Returned only in getMe. - Field: can_read_all_group_messages Type: Boolean Description: Optional. True, if privacy mode is disabled for the bot. Returned only in getMe. - Field: supports_inline_queries Type: Boolean Description: Optional. True, if the bot supports inline queries. Returned only in getMe. - name: Chat children: [] desc: - name: p content: This object represents a chat. table: - Field: id Type: Integer Description: Unique identifier for this chat. This number 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. - Field: type Type: String Description: Type of chat, can be either “private”, “group”, “supergroup” or “channel” - Field: title Type: String Description: Optional. Title, for supergroups, channels and group chats - Field: username Type: String Description: Optional. Username, for private chats, supergroups and channels if available - Field: first_name Type: String Description: Optional. First name of the other party in a private chat - Field: last_name Type: String Description: Optional. Last name of the other party in a private chat - Field: photo Type: ChatPhoto Description: Optional. Chat photo. Returned only in getChat. - Field: description Type: String Description: Optional. Description, for groups, supergroups and channel chats. Returned only in getChat. - Field: invite_link Type: String Description: Optional. Chat invite link, for groups, supergroups and channel chats. Each administrator in a chat generates their own invite links, so the bot must first generate the link using exportChatInviteLink. Returned only in getChat. - Field: pinned_message Type: Message Description: Optional. Pinned message, for groups, supergroups and channels. Returned only in getChat. - Field: permissions Type: ChatPermissions Description: Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat. - Field: slow_mode_delay Type: Integer Description: Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user. Returned only in getChat. - Field: sticker_set_name Type: String Description: Optional. For supergroups, name of group sticker set. Returned only in getChat. - Field: can_set_sticker_set Type: Boolean Description: Optional. True, if the bot can change the group sticker set. Returned only in getChat. - name: Message children: [] desc: - name: p content: This object represents a message. table: - Field: message_id Type: Integer Description: Unique message identifier inside this chat - Field: from Type: User Description: Optional. Sender, empty for messages sent to channels - Field: date Type: Integer Description: Date the message was sent in Unix time - Field: chat Type: Chat Description: Conversation the message belongs to - Field: forward_from Type: User Description: Optional. For forwarded messages, sender of the original message - Field: forward_from_chat Type: Chat Description: Optional. For messages forwarded from channels, information about the original channel - Field: forward_from_message_id Type: Integer Description: Optional. For messages forwarded from channels, identifier of the original message in the channel - Field: forward_signature Type: String Description: Optional. For messages forwarded from channels, signature of the post author if present - Field: forward_sender_name Type: String Description: Optional. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages - Field: forward_date Type: Integer Description: Optional. For forwarded messages, date the original message was sent in Unix time - Field: reply_to_message Type: Message 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. - Field: edit_date Type: Integer Description: Optional. Date the message was last edited in Unix time - Field: media_group_id Type: String Description: Optional. The unique identifier of a media message group this message belongs to - Field: author_signature Type: String Description: Optional. Signature of the post author for messages in channels - Field: text Type: String Description: Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters - Field: entities Type: Array of MessageEntity Description: Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text - Field: caption_entities Type: Array of MessageEntity Description: Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption - Field: audio Type: Audio Description: Optional. Message is an audio file, information about the file - Field: document Type: Document Description: Optional. Message is a general file, information about the file - Field: animation Type: Animation 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 - Field: game Type: Game Description: Optional. Message is a game, information about the game. More about games » - Field: photo Type: Array of PhotoSize Description: Optional. Message is a photo, available sizes of the photo - Field: sticker Type: Sticker Description: Optional. Message is a sticker, information about the sticker - Field: video Type: Video Description: Optional. Message is a video, information about the video - Field: voice Type: Voice Description: Optional. Message is a voice message, information about the file - Field: video_note Type: VideoNote Description: Optional. Message is a video note, information about the video message - Field: caption Type: String Description: Optional. Caption for the animation, audio, document, photo, video or voice, 0-1024 characters - Field: contact Type: Contact Description: Optional. Message is a shared contact, information about the contact - Field: location Type: Location Description: Optional. Message is a shared location, information about the location - Field: venue Type: Venue Description: Optional. Message is a venue, information about the venue - Field: poll Type: Poll Description: Optional. Message is a native poll, information about the poll - Field: dice Type: Dice Description: Optional. Message is a dice with random value from 1 to 6 - Field: new_chat_members Type: Array of User 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) - Field: left_chat_member Type: User Description: Optional. A member was removed from the group, information about them (this member may be the bot itself) - Field: new_chat_title Type: String Description: Optional. A chat title was changed to this value - Field: new_chat_photo Type: Array of PhotoSize Description: Optional. A chat photo was change to this value - Field: delete_chat_photo Type: 'True' Description: 'Optional. Service message: the chat photo was deleted' - Field: group_chat_created Type: 'True' Description: 'Optional. Service message: the group has been created' - Field: supergroup_chat_created Type: 'True' 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.' - Field: channel_chat_created Type: 'True' 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.' - Field: migrate_to_chat_id Type: Integer Description: Optional. The group has been migrated to a supergroup with the specified identifier. This number 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. - Field: migrate_from_chat_id Type: Integer Description: Optional. The supergroup has been migrated from a group with the specified identifier. This number 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. - Field: pinned_message Type: Message 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. - Field: invoice Type: Invoice Description: Optional. Message is an invoice for a payment, information about the invoice. More about payments » - Field: successful_payment Type: SuccessfulPayment Description: Optional. Message is a service message about a successful payment, information about the payment. More about payments » - Field: connected_website Type: String Description: Optional. The domain name of the website on which the user has logged in. More about Telegram Login » - Field: passport_data Type: PassportData Description: Optional. Telegram Passport data - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons. - name: MessageEntity children: [] desc: - name: p content: This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. table: - Field: type Type: String Description: Type of the entity. Can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames) - Field: offset Type: Integer Description: Offset in UTF-16 code units to the start of the entity - Field: length Type: Integer Description: Length of the entity in UTF-16 code units - Field: url Type: String Description: Optional. For “text_link” only, url that will be opened after user taps on the text - Field: user Type: User Description: Optional. For “text_mention” only, the mentioned user - Field: language Type: String Description: Optional. For “pre” only, the programming language of the entity text - name: PhotoSize children: [] desc: - name: p content: This object represents one size of a photo or a file / sticker thumbnail. table: - Field: file_id Type: String Description: Identifier for this file, which can be used to download or reuse the file - Field: file_unique_id Type: String 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. - Field: width Type: Integer Description: Photo width - Field: height Type: Integer Description: Photo height - Field: file_size Type: Integer Description: Optional. File size - name: Audio children: [] desc: - name: p content: This object represents an audio file to be treated as music by the Telegram clients. table: - Field: file_id Type: String Description: Identifier for this file, which can be used to download or reuse the file - Field: file_unique_id Type: String 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. - Field: duration Type: Integer Description: Duration of the audio in seconds as defined by sender - Field: performer Type: String Description: Optional. Performer of the audio as defined by sender or by audio tags - Field: title Type: String Description: Optional. Title of the audio as defined by sender or by audio tags - Field: mime_type Type: String Description: Optional. MIME type of the file as defined by sender - Field: file_size Type: Integer Description: Optional. File size - Field: thumb Type: PhotoSize Description: Optional. Thumbnail of the album cover to which the music file belongs - name: Document children: [] desc: - name: p content: This object represents a general file (as opposed to photos, voice messages and audio files). table: - Field: file_id Type: String Description: Identifier for this file, which can be used to download or reuse the file - Field: file_unique_id Type: String 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. - Field: thumb Type: PhotoSize Description: Optional. Document thumbnail as defined by sender - Field: file_name Type: String Description: Optional. Original filename as defined by sender - Field: mime_type Type: String Description: Optional. MIME type of the file as defined by sender - Field: file_size Type: Integer Description: Optional. File size - name: Video children: [] desc: - name: p content: This object represents a video file. table: - Field: file_id Type: String Description: Identifier for this file, which can be used to download or reuse the file - Field: file_unique_id Type: String 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. - Field: width Type: Integer Description: Video width as defined by sender - Field: height Type: Integer Description: Video height as defined by sender - Field: duration Type: Integer Description: Duration of the video in seconds as defined by sender - Field: thumb Type: PhotoSize Description: Optional. Video thumbnail - Field: mime_type Type: String Description: Optional. Mime type of a file as defined by sender - Field: file_size Type: Integer Description: Optional. File size - name: Animation children: [] desc: - name: p content: This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). table: - Field: file_id Type: String Description: Identifier for this file, which can be used to download or reuse the file - Field: file_unique_id Type: String 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. - Field: width Type: Integer Description: Video width as defined by sender - Field: height Type: Integer Description: Video height as defined by sender - Field: duration Type: Integer Description: Duration of the video in seconds as defined by sender - Field: thumb Type: PhotoSize Description: Optional. Animation thumbnail as defined by sender - Field: file_name Type: String Description: Optional. Original animation filename as defined by sender - Field: mime_type Type: String Description: Optional. MIME type of the file as defined by sender - Field: file_size Type: Integer Description: Optional. File size - name: Voice children: [] desc: - name: p content: This object represents a voice note. table: - Field: file_id Type: String Description: Identifier for this file, which can be used to download or reuse the file - Field: file_unique_id Type: String 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. - Field: duration Type: Integer Description: Duration of the audio in seconds as defined by sender - Field: mime_type Type: String Description: Optional. MIME type of the file as defined by sender - Field: file_size Type: Integer Description: Optional. File size - name: VideoNote children: [] desc: - name: p content: This object represents a video message (available in Telegram apps as of v.4.0). table: - Field: file_id Type: String Description: Identifier for this file, which can be used to download or reuse the file - Field: file_unique_id Type: String 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. - Field: length Type: Integer Description: Video width and height (diameter of the video message) as defined by sender - Field: duration Type: Integer Description: Duration of the video in seconds as defined by sender - Field: thumb Type: PhotoSize Description: Optional. Video thumbnail - Field: file_size Type: Integer Description: Optional. File size - name: Contact children: [] desc: - name: p content: This object represents a phone contact. table: - Field: phone_number Type: String Description: Contact's phone number - Field: first_name Type: String Description: Contact's first name - Field: last_name Type: String Description: Optional. Contact's last name - Field: user_id Type: Integer Description: Optional. Contact's user identifier in Telegram - Field: vcard Type: String Description: Optional. Additional data about the contact in the form of a vCard - name: Location children: [] desc: - name: p content: This object represents a point on the map. table: - Field: longitude Type: Float Description: Longitude as defined by sender - Field: latitude Type: Float Description: Latitude as defined by sender - name: Venue children: [] desc: - name: p content: This object represents a venue. table: - Field: location Type: Location Description: Venue location - Field: title Type: String Description: Name of the venue - Field: address Type: String Description: Address of the venue - Field: foursquare_id Type: String Description: Optional. Foursquare identifier of the venue - Field: foursquare_type Type: String Description: Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) - name: PollOption children: [] desc: - name: p content: This object contains information about one answer option in a poll. table: - Field: text Type: String Description: Option text, 1-100 characters - Field: voter_count Type: Integer Description: Number of users that voted for this option - name: PollAnswer children: [] desc: - name: p content: This object represents an answer of a user in a non-anonymous poll. table: - Field: poll_id Type: String Description: Unique poll identifier - Field: user Type: User Description: The user, who changed the answer to the poll - Field: option_ids Type: Array of Integer Description: 0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote. - name: Poll children: [] desc: - name: p content: This object contains information about a poll. table: - Field: id Type: String Description: Unique poll identifier - Field: question Type: String Description: Poll question, 1-255 characters - Field: options Type: Array of PollOption Description: List of poll options - Field: total_voter_count Type: Integer Description: Total number of users that voted in the poll - Field: is_closed Type: Boolean Description: True, if the poll is closed - Field: is_anonymous Type: Boolean Description: True, if the poll is anonymous - Field: type Type: String Description: Poll type, currently can be “regular” or “quiz” - Field: allows_multiple_answers Type: Boolean Description: True, if the poll allows multiple answers - Field: correct_option_id Type: Integer 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: Dice children: [] desc: - name: p content: This object represents a dice with random value from 1 to 6. (Yes, we're aware of the “proper” singular of die. But it's awkward, and we decided to help it change. One dice at a time!) table: - Field: value Type: Integer Description: Value of the dice, 1-6 - name: UserProfilePhotos children: [] desc: - name: p content: This object represent a user's profile pictures. table: - Field: total_count Type: Integer Description: Total number of profile pictures the target user has - Field: photos Type: Array of Array of PhotoSize Description: Requested profile pictures (in up to 4 sizes each) - name: File children: [] desc: - name: p content: This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot/. 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. - name: blockquote content: Maximum file size to download is 20 MB table: - Field: file_id Type: String Description: Identifier for this file, which can be used to download or reuse the file - Field: file_unique_id Type: String 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. - Field: file_size Type: Integer Description: Optional. File size, if known - Field: file_path Type: String Description: Optional. File path. Use https://api.telegram.org/file/bot/ to get the file. - name: ReplyKeyboardMarkup children: [] desc: - name: p content: This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). table: - Field: keyboard Type: Array of Array of KeyboardButton Description: Array of button rows, each represented by an Array of KeyboardButton objects - Field: resize_keyboard Type: Boolean 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. - Field: one_time_keyboard Type: Boolean 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. - Field: selective Type: Boolean 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.' - name: KeyboardButton children: [] desc: - name: p content: 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 request_contact, request_location, and request_poll are mutually exclusive. - name: p content: 'Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.' table: - Field: text Type: String Description: Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed - Field: request_contact Type: Boolean Description: Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only - Field: request_location Type: Boolean Description: Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only - Field: request_poll Type: KeyboardButtonPollType 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: KeyboardButtonPollType children: [] desc: - name: p content: This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed. table: - Field: type Type: String 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. - name: ReplyKeyboardRemove children: [] desc: - name: p content: 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). table: - Field: remove_keyboard Type: 'True' 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) - Field: selective Type: Boolean 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.' - name: InlineKeyboardMarkup children: [] desc: - name: p content: This object represents an inline keyboard that appears right next to the message it belongs to. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message.' table: - Field: inline_keyboard Type: Array of Array of InlineKeyboardButton Description: Array of button rows, each represented by an Array of InlineKeyboardButton objects - name: InlineKeyboardButton children: [] desc: - name: p content: This object represents one button of an inline keyboard. You must use exactly one of the optional fields. table: - Field: text Type: String Description: Label text on the button - Field: url Type: String Description: Optional. HTTP or tg:// url to be opened when button is pressed - Field: login_url Type: LoginUrl Description: Optional. An HTTP URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget. - Field: callback_data Type: String Description: Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes - Field: switch_inline_query Type: String 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. Can 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.' - Field: switch_inline_query_current_chat Type: String 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. Can 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. - Field: callback_game Type: CallbackGame 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.' - Field: pay Type: Boolean Description: 'Optional. Specify True, to send a Pay button.NOTE: This type of button must always be the first button in the first row.' - name: LoginUrl children: [] desc: - name: p content: '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:' - name: p content: Telegram apps support these buttons as of version 5.7. - name: blockquote content: 'Sample bot: @discussbot' table: - Field: url Type: String Description: 'An HTTP 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.' - Field: forward_text Type: String Description: Optional. New text of the button in forwarded messages. - Field: bot_username Type: String 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. - Field: request_write_access Type: Boolean Description: Optional. Pass True to request the permission for your bot to send messages to the user. - name: CallbackQuery children: [] desc: - name: p content: 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. - name: blockquote content: 'NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).' table: - Field: id Type: String Description: Unique identifier for this query - Field: from Type: User Description: Sender - Field: message Type: Message 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 - Field: inline_message_id Type: String Description: Optional. Identifier of the message sent via the bot in inline mode, that originated the query. - Field: chat_instance Type: String Description: Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games. - Field: data Type: String Description: Optional. Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field. - Field: game_short_name Type: String Description: Optional. Short name of a Game to be returned, serves as the unique identifier for the game - name: ForceReply children: [] desc: - name: p content: 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. - name: blockquote content: |- Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll: Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish. Guide the user through a step-by-step process. ‘Please send me your question’, ‘Cool, now let’s add the first answer option‘, ’Great. Keep adding answer options, then send /done when you‘re ready’. The last option is definitely more attractive. And if you use ForceReply in your bot‘s questions, it will receive the user’s answers even if it only receives replies, commands and mentions — without any extra work for the user. table: - Field: force_reply Type: 'True' Description: Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply' - Field: selective Type: Boolean 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.' - name: ChatPhoto children: [] desc: - name: p content: This object represents a chat photo. table: - Field: small_file_id Type: String 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. - Field: small_file_unique_id Type: String 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. - Field: big_file_id Type: String 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. - Field: big_file_unique_id Type: String 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. - name: ChatMember children: [] desc: - name: p content: This object contains information about one member of a chat. table: - Field: user Type: User Description: Information about the user - Field: status Type: String Description: The member's status in the chat. Can be “creator”, “administrator”, “member”, “restricted”, “left” or “kicked” - Field: custom_title Type: String Description: Optional. Owner and administrators only. Custom title for this user - Field: until_date Type: Integer Description: Optional. Restricted and kicked only. Date when restrictions will be lifted for this user; unix time - Field: can_be_edited Type: Boolean Description: Optional. Administrators only. True, if the bot is allowed to edit administrator privileges of that user - Field: can_post_messages Type: Boolean Description: Optional. Administrators only. True, if the administrator can post in the channel; channels only - Field: can_edit_messages Type: Boolean Description: Optional. Administrators only. True, if the administrator can edit messages of other users and can pin messages; channels only - Field: can_delete_messages Type: Boolean Description: Optional. Administrators only. True, if the administrator can delete messages of other users - Field: can_restrict_members Type: Boolean Description: Optional. Administrators only. True, if the administrator can restrict, ban or unban chat members - Field: can_promote_members Type: Boolean Description: Optional. Administrators only. True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user) - Field: can_change_info Type: Boolean Description: Optional. Administrators and restricted only. True, if the user is allowed to change the chat title, photo and other settings - Field: can_invite_users Type: Boolean Description: Optional. Administrators and restricted only. True, if the user is allowed to invite new users to the chat - Field: can_pin_messages Type: Boolean Description: Optional. Administrators and restricted only. True, if the user is allowed to pin messages; groups and supergroups only - Field: is_member Type: Boolean Description: Optional. Restricted only. True, if the user is a member of the chat at the moment of the request - Field: can_send_messages Type: Boolean Description: Optional. Restricted only. True, if the user is allowed to send text messages, contacts, locations and venues - Field: can_send_media_messages Type: Boolean Description: Optional. Restricted only. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes - Field: can_send_polls Type: Boolean Description: Optional. Restricted only. True, if the user is allowed to send polls - Field: can_send_other_messages Type: Boolean Description: Optional. Restricted only. True, if the user is allowed to send animations, games, stickers and use inline bots - Field: can_add_web_page_previews Type: Boolean Description: Optional. Restricted only. True, if the user is allowed to add web page previews to their messages - name: ChatPermissions children: [] desc: - name: p content: Describes actions that a non-administrator user is allowed to take in a chat. table: - Field: can_send_messages Type: Boolean Description: Optional. True, if the user is allowed to send text messages, contacts, locations and venues - Field: can_send_media_messages Type: Boolean Description: Optional. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages - Field: can_send_polls Type: Boolean Description: Optional. True, if the user is allowed to send polls, implies can_send_messages - Field: can_send_other_messages Type: Boolean Description: Optional. True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages - Field: can_add_web_page_previews Type: Boolean Description: Optional. True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages - Field: can_change_info Type: Boolean Description: Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups - Field: can_invite_users Type: Boolean Description: Optional. True, if the user is allowed to invite new users to the chat - Field: can_pin_messages Type: Boolean Description: Optional. True, if the user is allowed to pin messages. Ignored in public supergroups - name: BotCommand children: [] desc: - name: p content: This object represents a bot command. table: - Field: command Type: String Description: Text of the command, 1-32 characters. Can contain only lowercase English letters, digits and underscores. - Field: description Type: String Description: Description of the command, 3-256 characters. - name: ResponseParameters children: [] desc: - name: p content: Contains information about why a request was unsuccessful. table: - Field: migrate_to_chat_id Type: Integer Description: Optional. The group has been migrated to a supergroup with the specified identifier. This number 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. - Field: retry_after Type: Integer Description: Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated - name: InputMedia children: [] desc: - name: p content: This object represents the content of a media message to be sent. It should be one of - name: ul content: - InputMediaAnimation - InputMediaDocument - InputMediaAudio - InputMediaPhoto - InputMediaVideo - name: InputMediaPhoto children: [] desc: - name: p content: Represents a photo to be sent. table: - Field: type Type: String Description: Type of the result, must be photo - Field: media Type: String 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://” to upload a new one using multipart/form-data under name. More info on Sending Files » - Field: caption Type: String Description: Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - name: InputMediaVideo children: [] desc: - name: p content: Represents a video to be sent. table: - Field: type Type: String Description: Type of the result, must be video - Field: media Type: String 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://” to upload a new one using multipart/form-data under name. More info on Sending Files » - Field: thumb Type: InputFile or String 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://” if the thumbnail was uploaded using multipart/form-data under . More info on Sending Files » - Field: caption Type: String Description: Optional. Caption of the video to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: width Type: Integer Description: Optional. Video width - Field: height Type: Integer Description: Optional. Video height - Field: duration Type: Integer Description: Optional. Video duration - Field: supports_streaming Type: Boolean Description: Optional. Pass True, if the uploaded video is suitable for streaming - name: InputMediaAnimation children: [] desc: - name: p content: Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. table: - Field: type Type: String Description: Type of the result, must be animation - Field: media Type: String 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://” to upload a new one using multipart/form-data under name. More info on Sending Files » - Field: thumb Type: InputFile or String 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://” if the thumbnail was uploaded using multipart/form-data under . More info on Sending Files » - Field: caption Type: String Description: Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: width Type: Integer Description: Optional. Animation width - Field: height Type: Integer Description: Optional. Animation height - Field: duration Type: Integer Description: Optional. Animation duration - name: InputMediaAudio children: [] desc: - name: p content: Represents an audio file to be treated as music to be sent. table: - Field: type Type: String Description: Type of the result, must be audio - Field: media Type: String 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://” to upload a new one using multipart/form-data under name. More info on Sending Files » - Field: thumb Type: InputFile or String 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://” if the thumbnail was uploaded using multipart/form-data under . More info on Sending Files » - Field: caption Type: String Description: Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: duration Type: Integer Description: Optional. Duration of the audio in seconds - Field: performer Type: String Description: Optional. Performer of the audio - Field: title Type: String Description: Optional. Title of the audio - name: InputMediaDocument children: [] desc: - name: p content: Represents a general file to be sent. table: - Field: type Type: String Description: Type of the result, must be document - Field: media Type: String 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://” to upload a new one using multipart/form-data under name. More info on Sending Files » - Field: thumb Type: InputFile or String 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://” if the thumbnail was uploaded using multipart/form-data under . More info on Sending Files » - Field: caption Type: String Description: Optional. Caption of the document to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - name: InputFile children: [] desc: - name: p content: 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. - name: Sending files children: [] desc: - name: p content: 'There are three ways to send files (photos, stickers, audio, media, etc.):' - name: ol content: - 'If the file is already stored somewhere on the Telegram servers, you don''t need to reupload it: each file object has a file_id field, simply pass this file_id as a parameter instead of uploading. There are no limits for files sent this way.' - Provide Telegram with an HTTP URL for the file to be sent. Telegram will download and send the file. 5 MB max size for photos and 20 MB max for other types of content. - Post the file using multipart/form-data in the usual way that files are uploaded via the browser. 10 MB max size for photos, 50 MB for other files. - name: p content: Sending by file_id - name: ul content: - It is not possible to change the file type when resending by file_id. I.e. a video can't be sent as a photo, a photo can't be sent as a document, etc. - It is not possible to resend thumbnails. - Resending a photo by file_id will send all of its sizes. - file_id is unique for each individual bot and can't be transferred from one bot to another. - file_id uniquely identifies a file, but a file can have different valid file_ids even for the same bot. - name: p content: Sending by URL - name: ul content: - When sending by URL the target file must have the correct MIME type (e.g., audio/mpeg for sendAudio, etc.). - In sendDocument, sending by URL will currently only work for gif, pdf and zip files. - To use sendVoice, the file must have the type audio/ogg and be no more than 1MB in size. 1–20MB voice notes will be sent as files. - Other configurations may work but we can't guarantee that they will. - name: Inline mode objects children: [] desc: - name: p content: Objects and methods used in the inline mode are described in the Inline mode section. desc: - name: p content: All types used in the Bot API responses are represented as JSON-objects. - name: p content: It is safe to use 32-bit signed integers for storing all Integer fields unless otherwise noted. - name: blockquote content: Optional fields may be not returned when irrelevant. - name: Available methods children: - name: getMe children: [] desc: - name: p content: A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object. - name: sendMessage children: [] desc: - name: p content: Use this method to send text messages. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: text Type: String Required: 'Yes' Description: Text of the message to be sent, 1-4096 characters after entities parsing - Parameter: parse_mode Type: String Required: Optional Description: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. - Parameter: disable_web_page_preview Type: Boolean Required: Optional Description: Disables link previews for links in this message - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: Formatting options children: [] desc: - name: p content: The Bot API supports basic formatting for messages. You can use bold, italic, underlined and strikethrough text, as well as inline links and pre-formatted code in your bots' messages. Telegram clients will render them accordingly. You can use either markdown-style or HTML-style formatting. - name: p content: Note that Telegram clients will display an alert to the user before opening an inline link (‘Open this link?’ together with the full URL). - name: p content: Message entities can be nested, providing following restrictions are met:- If two entities has common characters then one of them is fully contained inside another.- bold, italic, underline and strikethrough entities can contain and to be contained in any other entities, except pre and code.- All other entities can't contain each other. - name: p content: 'Links tg://user?id= can be used to mention a user by their ID without using a username. Please note:' - name: ul content: - These links will work only if they are used inside an inline link. For example, they will not work, when used in an inline keyboard button or in a message text. - These mentions are only guaranteed to work if the user has contacted the bot in the past, has sent a callback query to the bot via inline button or is a member in the group where he was mentioned. - name: h6 content: MarkdownV2 style - name: p content: 'To use this mode, pass MarkdownV2 in the parse_mode field. Use the following syntax in your message:' - name: pre content: |- *bold \*text* _italic \*text_ __underline__ ~strikethrough~ *bold _italic bold ~italic bold strikethrough~ __underline italic bold___ bold* [inline URL](http://www.example.com/) [inline mention of a user](tg://user?id=123456789) `inline fixed-width code` ``` pre-formatted fixed-width code block ``` ```python pre-formatted fixed-width code block written in the Python programming language ``` - name: p content: 'Please note:' - name: ul content: - Any character between 1 and 126 inclusively can be escaped anywhere with a preceding '\' character, in which case it is treated as an ordinary character and not a part of the markup. - Inside pre and code entities, all '`‘ and ’\‘ characters must be escaped with a preceding ’\' character. - Inside (...) part of inline link definition, all ')‘ and ’\‘ must be escaped with a preceding ’\' character. - In all other places characters '_‘, ’*‘, ’[‘, ’]‘, ’(‘, ’)‘, ’~‘, ’`‘, ’>‘, ’#‘, ’+‘, ’-‘, ’=‘, ’|‘, ’{‘, ’}‘, ’.‘, ’!‘ must be escaped with the preceding character ’\'. - In case of ambiguity between italic and underline entities __ is always greadily treated from left to right as beginning or end of underline entity, so instead of ___italic underline___ use ___italic underline_\r__, where \r is a character with code 13, which will be ignored. - name: h6 content: HTML style - name: p content: 'To use this mode, pass HTML in the parse_mode field. The following tags are currently supported:' - name: pre content: |- bold, bold italic, italic underline, underline strikethrough, strikethrough, strikethrough bold italic bold italic bold strikethrough underline italic bold bold inline URL inline mention of a user inline fixed-width code 
pre-formatted fixed-width code block
pre-formatted fixed-width code block written in the Python programming language
- name: p content: 'Please note:' - name: ul content: - Only the tags mentioned above are currently supported. - All <, > and & symbols that are not a part of a tag or an HTML entity must be replaced with the corresponding HTML entities (< with <, > with > and & with &). - All numerical HTML entities are supported. - 'The API currently supports only the following named HTML entities: <, >, & and ".' - Use nested pre and code tags, to define programming language for pre entity. - Programming language can't be specified for standalone code tags. - name: h6 content: Markdown style - name: p content: 'This is a legacy mode, retained for backward compatibility. To use this mode, pass Markdown in the parse_mode field. Use the following syntax in your message:' - name: pre content: |- *bold text* _italic text_ [inline URL](http://www.example.com/) [inline mention of a user](tg://user?id=123456789) `inline fixed-width code` ``` pre-formatted fixed-width code block ``` ```python pre-formatted fixed-width code block written in the Python programming language ``` - name: p content: 'Please note:' - name: ul content: - Entities must not be nested, use parse mode MarkdownV2 instead. - There is no way to specify underline and strikethrough entities, use parse mode MarkdownV2 instead. - To escape characters '_‘, ’*‘, ’`‘, ’[‘ outside of an entity, prepend the characters ’\' before them. - 'Escaping inside entities is not allowed, so entity must be closed first and reopened again: use _snake_\__case_ for italic snake_case and *2*\**2=4* for bold 2*2=4.' - name: forwardMessage children: [] desc: - name: p content: Use this method to forward messages of any kind. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: from_chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: message_id Type: Integer Required: 'Yes' Description: Message identifier in the chat specified in from_chat_id - name: sendPhoto children: [] desc: - name: p content: Use this method to send photos. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: photo Type: InputFile or String Required: 'Yes' 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. More info on Sending Files » - Parameter: caption Type: String Required: Optional Description: Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing - Parameter: parse_mode Type: String Required: Optional Description: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendAudio children: [] desc: - name: p content: 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. - name: p content: For sending voice messages, use the sendVoice method instead. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: audio Type: InputFile or String Required: 'Yes' 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 info on Sending Files » - Parameter: caption Type: String Required: Optional Description: Audio caption, 0-1024 characters after entities parsing - Parameter: parse_mode Type: String Required: Optional Description: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Parameter: duration Type: Integer Required: Optional Description: Duration of the audio in seconds - Parameter: performer Type: String Required: Optional Description: Performer - Parameter: title Type: String Required: Optional Description: Track name - Parameter: thumb Type: InputFile or String Required: Optional 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://” if the thumbnail was uploaded using multipart/form-data under . More info on Sending Files » - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendDocument children: [] desc: - name: p content: 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. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: document Type: InputFile or String Required: 'Yes' 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 info on Sending Files » - Parameter: thumb Type: InputFile or String Required: Optional 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://” if the thumbnail was uploaded using multipart/form-data under . More info on Sending Files » - Parameter: caption Type: String Required: Optional Description: Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing - Parameter: parse_mode Type: String Required: Optional Description: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendVideo children: [] desc: - name: p content: Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: video Type: InputFile or String Required: 'Yes' 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 info on Sending Files » - Parameter: duration Type: Integer Required: Optional Description: Duration of sent video in seconds - Parameter: width Type: Integer Required: Optional Description: Video width - Parameter: height Type: Integer Required: Optional Description: Video height - Parameter: thumb Type: InputFile or String Required: Optional 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://” if the thumbnail was uploaded using multipart/form-data under . More info on Sending Files » - Parameter: caption Type: String Required: Optional Description: Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing - Parameter: parse_mode Type: String Required: Optional Description: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Parameter: supports_streaming Type: Boolean Required: Optional Description: Pass True, if the uploaded video is suitable for streaming - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendAnimation children: [] desc: - name: p content: 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. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: animation Type: InputFile or String Required: 'Yes' 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 info on Sending Files » - Parameter: duration Type: Integer Required: Optional Description: Duration of sent animation in seconds - Parameter: width Type: Integer Required: Optional Description: Animation width - Parameter: height Type: Integer Required: Optional Description: Animation height - Parameter: thumb Type: InputFile or String Required: Optional 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://” if the thumbnail was uploaded using multipart/form-data under . More info on Sending Files » - Parameter: caption Type: String Required: Optional Description: Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing - Parameter: parse_mode Type: String Required: Optional Description: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendVoice children: [] desc: - name: p content: 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. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: voice Type: InputFile or String Required: 'Yes' 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 info on Sending Files » - Parameter: caption Type: String Required: Optional Description: Voice message caption, 0-1024 characters after entities parsing - Parameter: parse_mode Type: String Required: Optional Description: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Parameter: duration Type: Integer Required: Optional Description: Duration of the voice message in seconds - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendVideoNote children: [] desc: - name: p content: As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: video_note Type: InputFile or String Required: 'Yes' 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 info on Sending Files ». Sending video notes by a URL is currently unsupported - Parameter: duration Type: Integer Required: Optional Description: Duration of sent video in seconds - Parameter: length Type: Integer Required: Optional Description: Video width and height, i.e. diameter of the video message - Parameter: thumb Type: InputFile or String Required: Optional 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://” if the thumbnail was uploaded using multipart/form-data under . More info on Sending Files » - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendMediaGroup children: [] desc: - name: p content: Use this method to send a group of photos or videos as an album. On success, an array of the sent Messages is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: media Type: Array of InputMediaPhoto and InputMediaVideo Required: 'Yes' Description: A JSON-serialized array describing photos and videos to be sent, must include 2–10 items - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the messages silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the messages are a reply, ID of the original message - name: sendLocation children: [] desc: - name: p content: Use this method to send point on the map. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: latitude Type: Float number Required: 'Yes' Description: Latitude of the location - Parameter: longitude Type: Float number Required: 'Yes' Description: Longitude of the location - Parameter: live_period Type: Integer Required: Optional Description: Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400. - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: editMessageLiveLocation children: [] desc: - name: p content: Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned. table: - Parameter: chat_id Type: Integer or String Required: Optional 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) - Parameter: message_id Type: Integer Required: Optional Description: Required if inline_message_id is not specified. Identifier of the message to edit - Parameter: inline_message_id Type: String Required: Optional Description: Required if chat_id and message_id are not specified. Identifier of the inline message - Parameter: latitude Type: Float number Required: 'Yes' Description: Latitude of new location - Parameter: longitude Type: Float number Required: 'Yes' Description: Longitude of new location - Parameter: reply_markup Type: InlineKeyboardMarkup Required: Optional Description: A JSON-serialized object for a new inline keyboard. - name: stopMessageLiveLocation children: [] desc: - name: p content: Use this method to stop updating a live location message before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned. table: - Parameter: chat_id Type: Integer or String Required: Optional 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) - Parameter: message_id Type: Integer Required: Optional Description: Required if inline_message_id is not specified. Identifier of the message with live location to stop - Parameter: inline_message_id Type: String Required: Optional Description: Required if chat_id and message_id are not specified. Identifier of the inline message - Parameter: reply_markup Type: InlineKeyboardMarkup Required: Optional Description: A JSON-serialized object for a new inline keyboard. - name: sendVenue children: [] desc: - name: p content: Use this method to send information about a venue. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: latitude Type: Float number Required: 'Yes' Description: Latitude of the venue - Parameter: longitude Type: Float number Required: 'Yes' Description: Longitude of the venue - Parameter: title Type: String Required: 'Yes' Description: Name of the venue - Parameter: address Type: String Required: 'Yes' Description: Address of the venue - Parameter: foursquare_id Type: String Required: Optional Description: Foursquare identifier of the venue - Parameter: foursquare_type Type: String Required: Optional Description: Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendContact children: [] desc: - name: p content: Use this method to send phone contacts. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: phone_number Type: String Required: 'Yes' Description: Contact's phone number - Parameter: first_name Type: String Required: 'Yes' Description: Contact's first name - Parameter: last_name Type: String Required: Optional Description: Contact's last name - Parameter: vcard Type: String Required: Optional Description: Additional data about the contact in the form of a vCard, 0-2048 bytes - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendPoll children: [] desc: - name: p content: Use this method to send a native poll. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: question Type: String Required: 'Yes' Description: Poll question, 1-255 characters - Parameter: options Type: Array of String Required: 'Yes' Description: A JSON-serialized list of answer options, 2-10 strings 1-100 characters each - Parameter: is_anonymous Type: Boolean Required: Optional Description: True, if the poll needs to be anonymous, defaults to True - Parameter: type Type: String Required: Optional Description: Poll type, “quiz” or “regular”, defaults to “regular” - Parameter: allows_multiple_answers Type: Boolean Required: Optional Description: True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False - Parameter: correct_option_id Type: Integer Required: Optional Description: 0-based identifier of the correct answer option, required for polls in quiz mode - Parameter: is_closed Type: Boolean Required: Optional Description: Pass True, if the poll needs to be immediately closed. This can be useful for poll preview. - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendDice children: [] desc: - name: p content: Use this method to send a dice, which will have a random value from 1 to 6. On success, the sent Message is returned. (Yes, we're aware of the “proper” singular of die. But it's awkward, and we decided to help it change. One dice at a time!) table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: sendChatAction children: [] desc: - name: p content: 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. - name: blockquote content: 'Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.' - name: p content: We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: action Type: String Required: 'Yes' 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_audio or upload_audio for audio files, upload_document for general files, find_location for location data, record_video_note or upload_video_note for video notes.' - name: getUserProfilePhotos children: [] desc: - name: p content: Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object. table: - Parameter: user_id Type: Integer Required: 'Yes' Description: Unique identifier of the target user - Parameter: offset Type: Integer Required: Optional Description: Sequential number of the first photo to be returned. By default, all photos are returned. - Parameter: limit Type: Integer Required: Optional Description: Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100. - name: getFile children: [] desc: - name: p content: Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot/, where 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. - name: p content: 'Note: This function may not preserve the original file name and MIME type. You should save the file''s MIME type and name (if available) when the File object is received.' table: - Parameter: file_id Type: String Required: 'Yes' Description: File identifier to get info about - name: kickChatMember children: [] desc: - name: p content: Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) - Parameter: user_id Type: Integer Required: 'Yes' Description: Unique identifier of the target user - Parameter: until_date Type: Integer Required: Optional 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 - name: unbanChatMember children: [] desc: - name: p content: Use this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target group or username of the target supergroup or channel (in the format @username) - Parameter: user_id Type: Integer Required: 'Yes' Description: Unique identifier of the target user - name: restrictChatMember children: [] desc: - name: p content: Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) - Parameter: user_id Type: Integer Required: 'Yes' Description: Unique identifier of the target user - Parameter: permissions Type: ChatPermissions Required: 'Yes' Description: New user permissions - Parameter: until_date Type: Integer Required: Optional 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 - name: promoteChatMember children: [] desc: - name: p content: Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: user_id Type: Integer Required: 'Yes' Description: Unique identifier of the target user - Parameter: can_change_info Type: Boolean Required: Optional Description: Pass True, if the administrator can change chat title, photo and other settings - Parameter: can_post_messages Type: Boolean Required: Optional Description: Pass True, if the administrator can create channel posts, channels only - Parameter: can_edit_messages Type: Boolean Required: Optional Description: Pass True, if the administrator can edit messages of other users and can pin messages, channels only - Parameter: can_delete_messages Type: Boolean Required: Optional Description: Pass True, if the administrator can delete messages of other users - Parameter: can_invite_users Type: Boolean Required: Optional Description: Pass True, if the administrator can invite new users to the chat - Parameter: can_restrict_members Type: Boolean Required: Optional Description: Pass True, if the administrator can restrict, ban or unban chat members - Parameter: can_pin_messages Type: Boolean Required: Optional Description: Pass True, if the administrator can pin messages, supergroups only - Parameter: can_promote_members Type: Boolean Required: Optional Description: Pass True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him) - name: setChatAdministratorCustomTitle children: [] desc: - name: p content: Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) - Parameter: user_id Type: Integer Required: 'Yes' Description: Unique identifier of the target user - Parameter: custom_title Type: String Required: 'Yes' Description: New custom title for the administrator; 0-16 characters, emoji are not allowed - name: setChatPermissions children: [] desc: - name: p content: 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 admin rights. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) - Parameter: permissions Type: ChatPermissions Required: 'Yes' Description: New default chat permissions - name: exportChatInviteLink children: [] desc: - name: p content: Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success. - name: blockquote content: 'Note: Each administrator in a chat generates their own invite links. Bots can''t use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink – after this the link will become available to the bot via the getChat method. If your bot needs to generate a new invite link replacing its previous one, use exportChatInviteLink again.' table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - name: setChatPhoto children: [] desc: - name: p content: Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: photo Type: InputFile Required: 'Yes' Description: New chat photo, uploaded using multipart/form-data - name: deleteChatPhoto children: [] desc: - name: p content: Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - name: setChatTitle children: [] desc: - name: p content: Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: title Type: String Required: 'Yes' Description: New chat title, 1-255 characters - name: setChatDescription children: [] desc: - name: p content: 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 admin rights. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: description Type: String Required: Optional Description: New chat description, 0-255 characters - name: pinChatMessage children: [] desc: - name: p content: Use this method to pin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: message_id Type: Integer Required: 'Yes' Description: Identifier of a message to pin - Parameter: disable_notification Type: Boolean Required: Optional 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. - name: unpinChatMessage children: [] desc: - name: p content: Use this method to unpin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - name: leaveChat children: [] desc: - name: p content: Use this method for your bot to leave a group, supergroup or channel. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) - name: getChat children: [] desc: - name: p content: 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. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) - name: getChatAdministrators children: [] desc: - name: p content: Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) - name: getChatMembersCount children: [] desc: - name: p content: Use this method to get the number of members in a chat. Returns Int on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) - name: getChatMember children: [] desc: - name: p content: Use this method to get information about a member of a chat. Returns a ChatMember object on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) - Parameter: user_id Type: Integer Required: 'Yes' Description: Unique identifier of the target user - name: setChatStickerSet children: [] desc: - name: p content: Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) - Parameter: sticker_set_name Type: String Required: 'Yes' Description: Name of the sticker set to be set as the group sticker set - name: deleteChatStickerSet children: [] desc: - name: p content: Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) - name: answerCallbackQuery children: [] desc: - name: p content: 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. - name: blockquote content: Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @Botfather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter. table: - Parameter: callback_query_id Type: String Required: 'Yes' Description: Unique identifier for the query to be answered - Parameter: text Type: String Required: Optional Description: Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters - Parameter: show_alert Type: Boolean Required: Optional Description: If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false. - Parameter: url Type: String Required: Optional 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. - Parameter: cache_time Type: Integer Required: Optional 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. - name: setMyCommands children: [] desc: - name: p content: Use this method to change the list of the bot's commands. Returns True on success. table: - Parameter: commands Type: Array of BotCommand Required: 'Yes' Description: A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified. - name: getMyCommands children: [] desc: - name: p content: Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of BotCommand on success. - name: Inline mode methods children: [] desc: - name: p content: Methods and objects used in the inline mode are described in the Inline mode section. desc: - name: blockquote content: All methods in the Bot API are case-insensitive. We support GET and POST HTTP methods. Use either URL query string or application/json or application/x-www-form-urlencoded or multipart/form-data for passing parameters in Bot API requests.On successful call, a JSON-object containing the result will be returned. - name: Updating messages children: - name: editMessageText children: [] desc: - name: p content: Use this method to edit text and game messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. table: - Parameter: chat_id Type: Integer or String Required: Optional 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) - Parameter: message_id Type: Integer Required: Optional Description: Required if inline_message_id is not specified. Identifier of the message to edit - Parameter: inline_message_id Type: String Required: Optional Description: Required if chat_id and message_id are not specified. Identifier of the inline message - Parameter: text Type: String Required: 'Yes' Description: New text of the message, 1-4096 characters after entities parsing - Parameter: parse_mode Type: String Required: Optional Description: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. - Parameter: disable_web_page_preview Type: Boolean Required: Optional Description: Disables link previews for links in this message - Parameter: reply_markup Type: InlineKeyboardMarkup Required: Optional Description: A JSON-serialized object for an inline keyboard. - name: editMessageCaption children: [] desc: - name: p content: Use this method to edit captions of messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. table: - Parameter: chat_id Type: Integer or String Required: Optional 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) - Parameter: message_id Type: Integer Required: Optional Description: Required if inline_message_id is not specified. Identifier of the message to edit - Parameter: inline_message_id Type: String Required: Optional Description: Required if chat_id and message_id are not specified. Identifier of the inline message - Parameter: caption Type: String Required: Optional Description: New caption of the message, 0-1024 characters after entities parsing - Parameter: parse_mode Type: String Required: Optional Description: Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Parameter: reply_markup Type: InlineKeyboardMarkup Required: Optional Description: A JSON-serialized object for an inline keyboard. - name: editMessageMedia children: [] desc: - name: p content: Use this method to edit animation, audio, document, photo, or video messages. If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can't be uploaded. Use previously uploaded file via its file_id or specify a URL. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned. table: - Parameter: chat_id Type: Integer or String Required: Optional 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) - Parameter: message_id Type: Integer Required: Optional Description: Required if inline_message_id is not specified. Identifier of the message to edit - Parameter: inline_message_id Type: String Required: Optional Description: Required if chat_id and message_id are not specified. Identifier of the inline message - Parameter: media Type: InputMedia Required: 'Yes' Description: A JSON-serialized object for a new media content of the message - Parameter: reply_markup Type: InlineKeyboardMarkup Required: Optional Description: A JSON-serialized object for a new inline keyboard. - name: editMessageReplyMarkup children: [] desc: - name: p content: Use this method to edit only the reply markup of messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. table: - Parameter: chat_id Type: Integer or String Required: Optional 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) - Parameter: message_id Type: Integer Required: Optional Description: Required if inline_message_id is not specified. Identifier of the message to edit - Parameter: inline_message_id Type: String Required: Optional Description: Required if chat_id and message_id are not specified. Identifier of the inline message - Parameter: reply_markup Type: InlineKeyboardMarkup Required: Optional Description: A JSON-serialized object for an inline keyboard. - name: stopPoll children: [] desc: - name: p content: Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: message_id Type: Integer Required: 'Yes' Description: Identifier of the original message with the poll - Parameter: reply_markup Type: InlineKeyboardMarkup Required: Optional Description: A JSON-serialized object for a new message inline keyboard. - name: deleteMessage children: [] desc: - name: p content: 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. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: message_id Type: Integer Required: 'Yes' Description: Identifier of the message to delete desc: - name: p content: The following methods allow you to change an existing message in the message history instead of sending a new one with a result of an action. This is most useful for messages with inline keyboards using callback queries, but can also help reduce clutter in conversations with regular chat bots. - name: p content: Please note, that it is currently only possible to edit messages without reply_markup or with inline keyboards. - name: Stickers children: - name: Sticker children: [] desc: - name: p content: This object represents a sticker. table: - Field: file_id Type: String Description: Identifier for this file, which can be used to download or reuse the file - Field: file_unique_id Type: String 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. - Field: width Type: Integer Description: Sticker width - Field: height Type: Integer Description: Sticker height - Field: is_animated Type: Boolean Description: True, if the sticker is animated - Field: thumb Type: PhotoSize Description: Optional. Sticker thumbnail in the .WEBP or .JPG format - Field: emoji Type: String Description: Optional. Emoji associated with the sticker - Field: set_name Type: String Description: Optional. Name of the sticker set to which the sticker belongs - Field: mask_position Type: MaskPosition Description: Optional. For mask stickers, the position where the mask should be placed - Field: file_size Type: Integer Description: Optional. File size - name: StickerSet children: [] desc: - name: p content: This object represents a sticker set. table: - Field: name Type: String Description: Sticker set name - Field: title Type: String Description: Sticker set title - Field: is_animated Type: Boolean Description: True, if the sticker set contains animated stickers - Field: contains_masks Type: Boolean Description: True, if the sticker set contains masks - Field: stickers Type: Array of Sticker Description: List of all set stickers - Field: thumb Type: PhotoSize Description: Optional. Sticker set thumbnail in the .WEBP or .TGS format - name: MaskPosition children: [] desc: - name: p content: This object describes the position on faces where a mask should be placed by default. table: - Field: point Type: String Description: The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”. - Field: x_shift Type: Float number 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. - Field: y_shift Type: Float number 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. - Field: scale Type: Float number Description: Mask scaling coefficient. For example, 2.0 means double size. - name: sendSticker children: [] desc: - name: p content: Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer or String Required: 'Yes' Description: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - Parameter: sticker Type: InputFile or String Required: 'Yes' 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 info on Sending Files » - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply Required: Optional 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. - name: getStickerSet children: [] desc: - name: p content: Use this method to get a sticker set. On success, a StickerSet object is returned. table: - Parameter: name Type: String Required: 'Yes' Description: Name of the sticker set - name: uploadStickerFile children: [] desc: - name: p content: 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. table: - Parameter: user_id Type: Integer Required: 'Yes' Description: User identifier of sticker file owner - Parameter: png_sticker Type: InputFile Required: 'Yes' 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 info on Sending Files » - name: createNewStickerSet children: [] desc: - name: p content: 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 or tgs_sticker. Returns True on success. table: - Parameter: user_id Type: Integer Required: 'Yes' Description: User identifier of created sticker set owner - Parameter: name Type: String Required: 'Yes' 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_”. is case insensitive. 1-64 characters. - Parameter: title Type: String Required: 'Yes' Description: Sticker set title, 1-64 characters - Parameter: png_sticker Type: InputFile or String Required: Optional 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 info on Sending Files » - Parameter: tgs_sticker Type: InputFile Required: Optional Description: TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements - Parameter: emojis Type: String Required: 'Yes' Description: One or more emoji corresponding to the sticker - Parameter: contains_masks Type: Boolean Required: Optional Description: Pass True, if a set of mask stickers should be created - Parameter: mask_position Type: MaskPosition Required: Optional Description: A JSON-serialized object for position where the mask should be placed on faces - name: addStickerToSet children: [] desc: - name: p content: 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 or tgs_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. table: - Parameter: user_id Type: Integer Required: 'Yes' Description: User identifier of sticker set owner - Parameter: name Type: String Required: 'Yes' Description: Sticker set name - Parameter: png_sticker Type: InputFile or String Required: 'Yes' 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 info on Sending Files » - Parameter: tgs_sticker Type: InputFile Required: Optional Description: TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements - Parameter: emojis Type: String Required: 'Yes' Description: One or more emoji corresponding to the sticker - Parameter: mask_position Type: MaskPosition Required: Optional Description: A JSON-serialized object for position where the mask should be placed on faces - name: setStickerPositionInSet children: [] desc: - name: p content: Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success. table: - Parameter: sticker Type: String Required: 'Yes' Description: File identifier of the sticker - Parameter: position Type: Integer Required: 'Yes' Description: New sticker position in the set, zero-based - name: deleteStickerFromSet children: [] desc: - name: p content: Use this method to delete a sticker from a set created by the bot. Returns True on success. table: - Parameter: sticker Type: String Required: 'Yes' Description: File identifier of the sticker - name: setStickerSetThumb children: [] desc: - name: p content: Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success. table: - Parameter: name Type: String Required: 'Yes' Description: Sticker set name - Parameter: user_id Type: Integer Required: 'Yes' Description: User identifier of the sticker set owner - Parameter: thumb Type: InputFile or String Required: Optional 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/animated_stickers#technical-requirements for animated 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 info on Sending Files ». Animated sticker set thumbnail can't be uploaded via HTTP URL. desc: - name: p content: The following methods and objects allow your bot to handle stickers and sticker sets. - name: Inline mode children: - name: InlineQuery children: [] desc: - name: p content: This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results. table: - Field: id Type: String Description: Unique identifier for this query - Field: from Type: User Description: Sender - Field: location Type: Location Description: Optional. Sender location, only for bots that request user location - Field: query Type: String Description: Text of the query (up to 256 characters) - Field: offset Type: String Description: Offset of the results to be returned, can be controlled by the bot - name: answerInlineQuery children: [] desc: - name: p content: Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed. table: - Parameter: inline_query_id Type: String Required: 'Yes' Description: Unique identifier for the answered query - Parameter: results Type: Array of InlineQueryResult Required: 'Yes' Description: A JSON-serialized array of results for the inline query - Parameter: cache_time Type: Integer Required: Optional Description: The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. - Parameter: is_personal Type: Boolean Required: Optional 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 - Parameter: next_offset Type: String Required: Optional 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. - Parameter: switch_pm_text Type: String Required: Optional 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 - Parameter: switch_pm_parameter Type: String Required: Optional 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.' - name: InlineQueryResult children: [] desc: - name: p content: 'This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:' - name: ul content: - InlineQueryResultCachedAudio - InlineQueryResultCachedDocument - InlineQueryResultCachedGif - InlineQueryResultCachedMpeg4Gif - InlineQueryResultCachedPhoto - InlineQueryResultCachedSticker - InlineQueryResultCachedVideo - InlineQueryResultCachedVoice - InlineQueryResultArticle - InlineQueryResultAudio - InlineQueryResultContact - InlineQueryResultGame - InlineQueryResultDocument - InlineQueryResultGif - InlineQueryResultLocation - InlineQueryResultMpeg4Gif - InlineQueryResultPhoto - InlineQueryResultVenue - InlineQueryResultVideo - InlineQueryResultVoice - name: InlineQueryResultArticle children: [] desc: - name: p content: Represents a link to an article or web page. table: - Field: type Type: String Description: Type of the result, must be article - Field: id Type: String Description: Unique identifier for this result, 1-64 Bytes - Field: title Type: String Description: Title of the result - Field: input_message_content Type: InputMessageContent Description: Content of the message to be sent - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: url Type: String Description: Optional. URL of the result - Field: hide_url Type: Boolean Description: Optional. Pass True, if you don't want the URL to be shown in the message - Field: description Type: String Description: Optional. Short description of the result - Field: thumb_url Type: String Description: Optional. Url of the thumbnail for the result - Field: thumb_width Type: Integer Description: Optional. Thumbnail width - Field: thumb_height Type: Integer Description: Optional. Thumbnail height - name: InlineQueryResultPhoto children: [] desc: - name: p content: 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. table: - Field: type Type: String Description: Type of the result, must be photo - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: photo_url Type: String Description: A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB - Field: thumb_url Type: String Description: URL of the thumbnail for the photo - Field: photo_width Type: Integer Description: Optional. Width of the photo - Field: photo_height Type: Integer Description: Optional. Height of the photo - Field: title Type: String Description: Optional. Title for the result - Field: description Type: String Description: Optional. Short description of the result - Field: caption Type: String Description: Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the photo - name: InlineQueryResultGif children: [] desc: - name: p content: 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. table: - Field: type Type: String Description: Type of the result, must be gif - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: gif_url Type: String Description: A valid URL for the GIF file. File size must not exceed 1MB - Field: gif_width Type: Integer Description: Optional. Width of the GIF - Field: gif_height Type: Integer Description: Optional. Height of the GIF - Field: gif_duration Type: Integer Description: Optional. Duration of the GIF - Field: thumb_url Type: String Description: URL of the static thumbnail for the result (jpeg or gif) - Field: title Type: String Description: Optional. Title for the result - Field: caption Type: String Description: Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the GIF animation - name: InlineQueryResultMpeg4Gif children: [] desc: - name: p content: 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. table: - Field: type Type: String Description: Type of the result, must be mpeg4_gif - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: mpeg4_url Type: String Description: A valid URL for the MP4 file. File size must not exceed 1MB - Field: mpeg4_width Type: Integer Description: Optional. Video width - Field: mpeg4_height Type: Integer Description: Optional. Video height - Field: mpeg4_duration Type: Integer Description: Optional. Video duration - Field: thumb_url Type: String Description: URL of the static thumbnail (jpeg or gif) for the result - Field: title Type: String Description: Optional. Title for the result - Field: caption Type: String Description: Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the video animation - name: InlineQueryResultVideo children: [] desc: - name: p content: 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. - name: blockquote content: If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using input_message_content. table: - Field: type Type: String Description: Type of the result, must be video - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: video_url Type: String Description: A valid URL for the embedded video player or video file - Field: mime_type Type: String Description: Mime type of the content of video url, “text/html” or “video/mp4” - Field: thumb_url Type: String Description: URL of the thumbnail (jpeg only) for the video - Field: title Type: String Description: Title for the result - Field: caption Type: String Description: Optional. Caption of the video to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: video_width Type: Integer Description: Optional. Video width - Field: video_height Type: Integer Description: Optional. Video height - Field: video_duration Type: Integer Description: Optional. Video duration in seconds - Field: description Type: String Description: Optional. Short description of the result - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent 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). - name: InlineQueryResultAudio children: [] desc: - name: p content: 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. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.' table: - Field: type Type: String Description: Type of the result, must be audio - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: audio_url Type: String Description: A valid URL for the audio file - Field: title Type: String Description: Title - Field: caption Type: String Description: Optional. Caption, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: performer Type: String Description: Optional. Performer - Field: audio_duration Type: Integer Description: Optional. Audio duration in seconds - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the audio - name: InlineQueryResultVoice children: [] desc: - name: p content: 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. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.' table: - Field: type Type: String Description: Type of the result, must be voice - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: voice_url Type: String Description: A valid URL for the voice recording - Field: title Type: String Description: Recording title - Field: caption Type: String Description: Optional. Caption, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: voice_duration Type: Integer Description: Optional. Recording duration in seconds - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the voice recording - name: InlineQueryResultDocument children: [] desc: - name: p content: 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. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.' table: - Field: type Type: String Description: Type of the result, must be document - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: title Type: String Description: Title for the result - Field: caption Type: String Description: Optional. Caption of the document to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: document_url Type: String Description: A valid URL for the file - Field: mime_type Type: String Description: Mime type of the content of the file, either “application/pdf” or “application/zip” - Field: description Type: String Description: Optional. Short description of the result - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the file - Field: thumb_url Type: String Description: Optional. URL of the thumbnail (jpeg only) for the file - Field: thumb_width Type: Integer Description: Optional. Thumbnail width - Field: thumb_height Type: Integer Description: Optional. Thumbnail height - name: InlineQueryResultLocation children: [] desc: - name: p content: 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. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.' table: - Field: type Type: String Description: Type of the result, must be location - Field: id Type: String Description: Unique identifier for this result, 1-64 Bytes - Field: latitude Type: Float number Description: Location latitude in degrees - Field: longitude Type: Float number Description: Location longitude in degrees - Field: title Type: String Description: Location title - Field: live_period Type: Integer Description: Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the location - Field: thumb_url Type: String Description: Optional. Url of the thumbnail for the result - Field: thumb_width Type: Integer Description: Optional. Thumbnail width - Field: thumb_height Type: Integer Description: Optional. Thumbnail height - name: InlineQueryResultVenue children: [] desc: - name: p content: 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. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.' table: - Field: type Type: String Description: Type of the result, must be venue - Field: id Type: String Description: Unique identifier for this result, 1-64 Bytes - Field: latitude Type: Float Description: Latitude of the venue location in degrees - Field: longitude Type: Float Description: Longitude of the venue location in degrees - Field: title Type: String Description: Title of the venue - Field: address Type: String Description: Address of the venue - Field: foursquare_id Type: String Description: Optional. Foursquare identifier of the venue if known - Field: foursquare_type Type: String Description: Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the venue - Field: thumb_url Type: String Description: Optional. Url of the thumbnail for the result - Field: thumb_width Type: Integer Description: Optional. Thumbnail width - Field: thumb_height Type: Integer Description: Optional. Thumbnail height - name: InlineQueryResultContact children: [] desc: - name: p content: 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. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.' table: - Field: type Type: String Description: Type of the result, must be contact - Field: id Type: String Description: Unique identifier for this result, 1-64 Bytes - Field: phone_number Type: String Description: Contact's phone number - Field: first_name Type: String Description: Contact's first name - Field: last_name Type: String Description: Optional. Contact's last name - Field: vcard Type: String Description: Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the contact - Field: thumb_url Type: String Description: Optional. Url of the thumbnail for the result - Field: thumb_width Type: Integer Description: Optional. Thumbnail width - Field: thumb_height Type: Integer Description: Optional. Thumbnail height - name: InlineQueryResultGame children: [] desc: - name: p content: Represents a Game. - name: p content: 'Note: This will only work in Telegram versions released after October 1, 2016. Older clients will not display any inline results if a game result is among them.' table: - Field: type Type: String Description: Type of the result, must be game - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: game_short_name Type: String Description: Short name of the game - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - name: InlineQueryResultCachedPhoto children: [] desc: - name: p content: 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. table: - Field: type Type: String Description: Type of the result, must be photo - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: photo_file_id Type: String Description: A valid file identifier of the photo - Field: title Type: String Description: Optional. Title for the result - Field: description Type: String Description: Optional. Short description of the result - Field: caption Type: String Description: Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the photo - name: InlineQueryResultCachedGif children: [] desc: - name: p content: 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. table: - Field: type Type: String Description: Type of the result, must be gif - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: gif_file_id Type: String Description: A valid file identifier for the GIF file - Field: title Type: String Description: Optional. Title for the result - Field: caption Type: String Description: Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the GIF animation - name: InlineQueryResultCachedMpeg4Gif children: [] desc: - name: p content: 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. table: - Field: type Type: String Description: Type of the result, must be mpeg4_gif - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: mpeg4_file_id Type: String Description: A valid file identifier for the MP4 file - Field: title Type: String Description: Optional. Title for the result - Field: caption Type: String Description: Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the video animation - name: InlineQueryResultCachedSticker children: [] desc: - name: p content: 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. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016 for static stickers and after 06 July, 2019 for animated stickers. Older clients will ignore them.' table: - Field: type Type: String Description: Type of the result, must be sticker - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: sticker_file_id Type: String Description: A valid file identifier of the sticker - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the sticker - name: InlineQueryResultCachedDocument children: [] desc: - name: p content: 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. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.' table: - Field: type Type: String Description: Type of the result, must be document - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: title Type: String Description: Title for the result - Field: document_file_id Type: String Description: A valid file identifier for the file - Field: description Type: String Description: Optional. Short description of the result - Field: caption Type: String Description: Optional. Caption of the document to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the file - name: InlineQueryResultCachedVideo children: [] desc: - name: p content: 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. table: - Field: type Type: String Description: Type of the result, must be video - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: video_file_id Type: String Description: A valid file identifier for the video file - Field: title Type: String Description: Title for the result - Field: description Type: String Description: Optional. Short description of the result - Field: caption Type: String Description: Optional. Caption of the video to be sent, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the video - name: InlineQueryResultCachedVoice children: [] desc: - name: p content: 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. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.' table: - Field: type Type: String Description: Type of the result, must be voice - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: voice_file_id Type: String Description: A valid file identifier for the voice message - Field: title Type: String Description: Voice message title - Field: caption Type: String Description: Optional. Caption, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the voice message - name: InlineQueryResultCachedAudio children: [] desc: - name: p content: 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. - name: p content: 'Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.' table: - Field: type Type: String Description: Type of the result, must be audio - Field: id Type: String Description: Unique identifier for this result, 1-64 bytes - Field: audio_file_id Type: String Description: A valid file identifier for the audio file - Field: caption Type: String Description: Optional. Caption, 0-1024 characters after entities parsing - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. - Field: reply_markup Type: InlineKeyboardMarkup Description: Optional. Inline keyboard attached to the message - Field: input_message_content Type: InputMessageContent Description: Optional. Content of the message to be sent instead of the audio - name: InputMessageContent children: [] desc: - name: p content: 'This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 4 types:' - name: ul content: - InputTextMessageContent - InputLocationMessageContent - InputVenueMessageContent - InputContactMessageContent - name: InputTextMessageContent children: [] desc: - name: p content: Represents the content of a text message to be sent as the result of an inline query. table: - Field: message_text Type: String Description: Text of the message to be sent, 1-4096 characters - Field: parse_mode Type: String Description: Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message. - Field: disable_web_page_preview Type: Boolean Description: Optional. Disables link previews for links in the sent message - name: InputLocationMessageContent children: [] desc: - name: p content: Represents the content of a location message to be sent as the result of an inline query. table: - Field: latitude Type: Float Description: Latitude of the location in degrees - Field: longitude Type: Float Description: Longitude of the location in degrees - Field: live_period Type: Integer Description: Optional. Period in seconds for which the location can be updated, should be between 60 and 86400. - name: InputVenueMessageContent children: [] desc: - name: p content: Represents the content of a venue message to be sent as the result of an inline query. table: - Field: latitude Type: Float Description: Latitude of the venue in degrees - Field: longitude Type: Float Description: Longitude of the venue in degrees - Field: title Type: String Description: Name of the venue - Field: address Type: String Description: Address of the venue - Field: foursquare_id Type: String Description: Optional. Foursquare identifier of the venue, if known - Field: foursquare_type Type: String Description: Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) - name: InputContactMessageContent children: [] desc: - name: p content: Represents the content of a contact message to be sent as the result of an inline query. table: - Field: phone_number Type: String Description: Contact's phone number - Field: first_name Type: String Description: Contact's first name - Field: last_name Type: String Description: Optional. Contact's last name - Field: vcard Type: String Description: Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes - name: ChosenInlineResult children: [] desc: - name: p content: Represents a result of an inline query that was chosen by the user and sent to their chat partner. - name: p content: 'Note: It is necessary to enable inline feedback via @Botfather in order to receive these objects in updates.' table: - Field: result_id Type: String Description: The unique identifier for the result that was chosen - Field: from Type: User Description: The user that chose the result - Field: location Type: Location Description: Optional. Sender location, only for bots that require user location - Field: inline_message_id Type: String 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. - Field: query Type: String Description: The query that was used to obtain the result desc: - name: p content: The following methods and objects allow your bot to work in inline mode.Please see our Introduction to Inline bots for more details. - name: p content: To enable this option, send the /setinline command to @BotFather and provide the placeholder text that the user will see in the input field after typing your bot’s name. - name: Payments children: - name: sendInvoice children: [] desc: - name: p content: Use this method to send invoices. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer Required: 'Yes' Description: Unique identifier for the target private chat - Parameter: title Type: String Required: 'Yes' Description: Product name, 1-32 characters - Parameter: description Type: String Required: 'Yes' Description: Product description, 1-255 characters - Parameter: payload Type: String Required: 'Yes' Description: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. - Parameter: provider_token Type: String Required: 'Yes' Description: Payments provider token, obtained via Botfather - Parameter: start_parameter Type: String Required: 'Yes' Description: Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter - Parameter: currency Type: String Required: 'Yes' Description: Three-letter ISO 4217 currency code, see more on currencies - Parameter: prices Type: Array of LabeledPrice Required: 'Yes' Description: Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) - Parameter: provider_data Type: String Required: Optional Description: JSON-encoded 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. - Parameter: photo_url Type: String Required: Optional 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. - Parameter: photo_size Type: Integer Required: Optional Description: Photo size - Parameter: photo_width Type: Integer Required: Optional Description: Photo width - Parameter: photo_height Type: Integer Required: Optional Description: Photo height - Parameter: need_name Type: Boolean Required: Optional Description: Pass True, if you require the user's full name to complete the order - Parameter: need_phone_number Type: Boolean Required: Optional Description: Pass True, if you require the user's phone number to complete the order - Parameter: need_email Type: Boolean Required: Optional Description: Pass True, if you require the user's email address to complete the order - Parameter: need_shipping_address Type: Boolean Required: Optional Description: Pass True, if you require the user's shipping address to complete the order - Parameter: send_phone_number_to_provider Type: Boolean Required: Optional Description: Pass True, if user's phone number should be sent to provider - Parameter: send_email_to_provider Type: Boolean Required: Optional Description: Pass True, if user's email address should be sent to provider - Parameter: is_flexible Type: Boolean Required: Optional Description: Pass True, if the final price depends on the shipping method - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup Required: Optional 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. - name: answerShippingQuery children: [] desc: - name: p content: 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. table: - Parameter: shipping_query_id Type: String Required: 'Yes' Description: Unique identifier for the query to be answered - Parameter: ok Type: Boolean Required: 'Yes' Description: Specify 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) - Parameter: shipping_options Type: Array of ShippingOption Required: Optional Description: Required if ok is True. A JSON-serialized array of available shipping options. - Parameter: error_message Type: String Required: Optional 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. - name: answerPreCheckoutQuery children: [] desc: - name: p content: '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.' table: - Parameter: pre_checkout_query_id Type: String Required: 'Yes' Description: Unique identifier for the query to be answered - Parameter: ok Type: Boolean Required: 'Yes' 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. - Parameter: error_message Type: String Required: Optional 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. - name: LabeledPrice children: [] desc: - name: p content: This object represents a portion of the price for goods or services. table: - Field: label Type: String Description: Portion label - Field: amount Type: Integer 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). - name: Invoice children: [] desc: - name: p content: This object contains basic information about an invoice. table: - Field: title Type: String Description: Product name - Field: description Type: String Description: Product description - Field: start_parameter Type: String Description: Unique bot deep-linking parameter that can be used to generate this invoice - Field: currency Type: String Description: Three-letter ISO 4217 currency code - Field: total_amount Type: Integer 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: ShippingAddress children: [] desc: - name: p content: This object represents a shipping address. table: - Field: country_code Type: String Description: ISO 3166-1 alpha-2 country code - Field: state Type: String Description: State, if applicable - Field: city Type: String Description: City - Field: street_line1 Type: String Description: First line for the address - Field: street_line2 Type: String Description: Second line for the address - Field: post_code Type: String Description: Address post code - name: OrderInfo children: [] desc: - name: p content: This object represents information about an order. table: - Field: name Type: String Description: Optional. User name - Field: phone_number Type: String Description: Optional. User's phone number - Field: email Type: String Description: Optional. User email - Field: shipping_address Type: ShippingAddress Description: Optional. User shipping address - name: ShippingOption children: [] desc: - name: p content: This object represents one shipping option. table: - Field: id Type: String Description: Shipping option identifier - Field: title Type: String Description: Option title - Field: prices Type: Array of LabeledPrice Description: List of price portions - name: SuccessfulPayment children: [] desc: - name: p content: This object contains basic information about a successful payment. table: - Field: currency Type: String Description: Three-letter ISO 4217 currency code - Field: total_amount Type: Integer 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). - Field: invoice_payload Type: String Description: Bot specified invoice payload - Field: shipping_option_id Type: String Description: Optional. Identifier of the shipping option chosen by the user - Field: order_info Type: OrderInfo Description: Optional. Order info provided by the user - Field: telegram_payment_charge_id Type: String Description: Telegram payment identifier - Field: provider_payment_charge_id Type: String Description: Provider payment identifier - name: ShippingQuery children: [] desc: - name: p content: This object contains information about an incoming shipping query. table: - Field: id Type: String Description: Unique query identifier - Field: from Type: User Description: User who sent the query - Field: invoice_payload Type: String Description: Bot specified invoice payload - Field: shipping_address Type: ShippingAddress Description: User specified shipping address - name: PreCheckoutQuery children: [] desc: - name: p content: This object contains information about an incoming pre-checkout query. table: - Field: id Type: String Description: Unique query identifier - Field: from Type: User Description: User who sent the query - Field: currency Type: String Description: Three-letter ISO 4217 currency code - Field: total_amount Type: Integer 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). - Field: invoice_payload Type: String Description: Bot specified invoice payload - Field: shipping_option_id Type: String Description: Optional. Identifier of the shipping option chosen by the user - Field: order_info Type: OrderInfo Description: Optional. Order info provided by the user desc: - name: p content: Your bot can accept payments from Telegram users. Please see the introduction to payments for more details on the process and how to set up payments for your bot. Please note that users will need Telegram v.4.0 or higher to use payments (released on May 18, 2017). - name: Telegram Passport children: - name: PassportData children: [] desc: - name: p content: Contains information about Telegram Passport data shared with the bot by the user. table: - Field: data Type: Array of EncryptedPassportElement Description: Array with information about documents and other Telegram Passport elements that was shared with the bot - Field: credentials Type: EncryptedCredentials Description: Encrypted credentials required to decrypt the data - name: PassportFile children: [] desc: - name: p content: 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. table: - Field: file_id Type: String Description: Identifier for this file, which can be used to download or reuse the file - Field: file_unique_id Type: String 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. - Field: file_size Type: Integer Description: File size - Field: file_date Type: Integer Description: Unix time when the file was uploaded - name: EncryptedPassportElement children: [] desc: - name: p content: Contains information about documents or other Telegram Passport elements shared with the bot by the user. table: - Field: type Type: String 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”. - Field: data Type: String 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. - Field: phone_number Type: String Description: Optional. User's verified phone number, available only for “phone_number” type - Field: email Type: String Description: Optional. User's verified email address, available only for “email” type - Field: files Type: Array of PassportFile 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. - Field: front_side Type: PassportFile 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. - Field: reverse_side Type: PassportFile 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. - Field: selfie Type: PassportFile 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. - Field: translation Type: Array of PassportFile 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. - Field: hash Type: String Description: Base64-encoded element hash for using in PassportElementErrorUnspecified - name: EncryptedCredentials children: [] desc: - name: p content: Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes. table: - Field: data Type: String Description: Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication - Field: hash Type: String Description: Base64-encoded data hash for data authentication - Field: secret Type: String Description: Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption - name: setPassportDataErrors children: [] desc: - name: p content: 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. - name: p content: Use this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues. table: - Parameter: user_id Type: Integer Required: 'Yes' Description: User identifier - Parameter: errors Type: Array of PassportElementError Required: 'Yes' Description: A JSON-serialized array describing the errors - name: PassportElementError children: [] desc: - name: p content: '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:' - name: ul content: - PassportElementErrorDataField - PassportElementErrorFrontSide - PassportElementErrorReverseSide - PassportElementErrorSelfie - PassportElementErrorFile - PassportElementErrorFiles - PassportElementErrorTranslationFile - PassportElementErrorTranslationFiles - PassportElementErrorUnspecified - name: PassportElementErrorDataField children: [] desc: - name: p content: 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. table: - Field: source Type: String Description: Error source, must be data - Field: type Type: String 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” - Field: field_name Type: String Description: Name of the data field which has the error - Field: data_hash Type: String Description: Base64-encoded data hash - Field: message Type: String Description: Error message - name: PassportElementErrorFrontSide children: [] desc: - name: p content: 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. table: - Field: source Type: String Description: Error source, must be front_side - Field: type Type: String Description: The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport” - Field: file_hash Type: String Description: Base64-encoded hash of the file with the front side of the document - Field: message Type: String Description: Error message - name: PassportElementErrorReverseSide children: [] desc: - name: p content: 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. table: - Field: source Type: String Description: Error source, must be reverse_side - Field: type Type: String Description: The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card” - Field: file_hash Type: String Description: Base64-encoded hash of the file with the reverse side of the document - Field: message Type: String Description: Error message - name: PassportElementErrorSelfie children: [] desc: - name: p content: Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. table: - Field: source Type: String Description: Error source, must be selfie - Field: type Type: String Description: The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport” - Field: file_hash Type: String Description: Base64-encoded hash of the file with the selfie - Field: message Type: String Description: Error message - name: PassportElementErrorFile children: [] desc: - name: p content: Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. table: - Field: source Type: String Description: Error source, must be file - Field: type Type: String 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” - Field: file_hash Type: String Description: Base64-encoded file hash - Field: message Type: String Description: Error message - name: PassportElementErrorFiles children: [] desc: - name: p content: Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes. table: - Field: source Type: String Description: Error source, must be files - Field: type Type: String 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” - Field: file_hashes Type: Array of String Description: List of base64-encoded file hashes - Field: message Type: String Description: Error message - name: PassportElementErrorTranslationFile children: [] desc: - name: p content: Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes. table: - Field: source Type: String Description: Error source, must be translation_file - Field: type Type: String 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” - Field: file_hash Type: String Description: Base64-encoded file hash - Field: message Type: String Description: Error message - name: PassportElementErrorTranslationFiles children: [] desc: - name: p content: Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change. table: - Field: source Type: String Description: Error source, must be translation_files - Field: type Type: String 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” - Field: file_hashes Type: Array of String Description: List of base64-encoded file hashes - Field: message Type: String Description: Error message - name: PassportElementErrorUnspecified children: [] desc: - name: p content: Represents an issue in an unspecified place. The error is considered resolved when new data is added. table: - Field: source Type: String Description: Error source, must be unspecified - Field: type Type: String Description: Type of element of the user's Telegram Passport which has the issue - Field: element_hash Type: String Description: Base64-encoded element hash - Field: message Type: String Description: Error message desc: - name: p content: Telegram Passport is a unified authorization method for services that require personal identification. Users can upload their documents once, then instantly share their data with services that require real-world ID (finance, ICOs, etc.). Please see the manual for details. - name: Games children: - name: sendGame children: [] desc: - name: p content: Use this method to send a game. On success, the sent Message is returned. table: - Parameter: chat_id Type: Integer Required: 'Yes' Description: Unique identifier for the target chat - Parameter: game_short_name Type: String Required: 'Yes' Description: Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather. - Parameter: disable_notification Type: Boolean Required: Optional Description: Sends the message silently. Users will receive a notification with no sound. - Parameter: reply_to_message_id Type: Integer Required: Optional Description: If the message is a reply, ID of the original message - Parameter: reply_markup Type: InlineKeyboardMarkup Required: Optional 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. - name: Game children: [] desc: - name: p content: This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers. table: - Field: title Type: String Description: Title of the game - Field: description Type: String Description: Description of the game - Field: photo Type: Array of PhotoSize Description: Photo that will be displayed in the game message in chats. - Field: text Type: String 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. - Field: text_entities Type: Array of MessageEntity Description: Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. - Field: animation Type: Animation Description: Optional. Animation that will be displayed in the game message in chats. Upload via BotFather - name: CallbackGame children: [] desc: - name: p content: A placeholder, currently holds no information. Use BotFather to set up your game. - name: setGameScore children: [] desc: - name: p content: Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False. table: - Parameter: user_id Type: Integer Required: 'Yes' Description: User identifier - Parameter: score Type: Integer Required: 'Yes' Description: New score, must be non-negative - Parameter: force Type: Boolean Required: Optional Description: Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters - Parameter: disable_edit_message Type: Boolean Required: Optional Description: Pass True, if the game message should not be automatically edited to include the current scoreboard - Parameter: chat_id Type: Integer Required: Optional Description: Required if inline_message_id is not specified. Unique identifier for the target chat - Parameter: message_id Type: Integer Required: Optional Description: Required if inline_message_id is not specified. Identifier of the sent message - Parameter: inline_message_id Type: String Required: Optional Description: Required if chat_id and message_id are not specified. Identifier of the inline message - name: getGameHighScores children: [] desc: - name: p content: Use this method to get data for high score tables. Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects. - name: blockquote content: This method will currently return scores for the target user, plus two of his closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change. table: - Parameter: user_id Type: Integer Required: 'Yes' Description: Target user id - Parameter: chat_id Type: Integer Required: Optional Description: Required if inline_message_id is not specified. Unique identifier for the target chat - Parameter: message_id Type: Integer Required: Optional Description: Required if inline_message_id is not specified. Identifier of the sent message - Parameter: inline_message_id Type: String Required: Optional Description: Required if chat_id and message_id are not specified. Identifier of the inline message - name: GameHighScore children: [] desc: - name: p content: This object represents one row of the high scores table for a game. - name: p content: And that‘s about all we’ve got for now.If you've got any questions, please check out our Bot FAQ » table: - Field: position Type: Integer Description: Position in high score table for the game - Field: user Type: User Description: User - Field: score Type: Integer Description: Score desc: - name: p content: 'Your bot can offer users HTML5 games to play solo or to compete against each other in groups and one-on-one chats. Create games via @BotFather using the /newgame command. Please note that this kind of power requires responsibility: you will need to accept the terms for each game that your bots will be offering.' - name: ul content: - Games are a new type of content on Telegram, represented by the Game and InlineQueryResultGame objects. - Once you've created a game via BotFather, you can send games to chats as regular messages using the sendGame method, or use inline mode with InlineQueryResultGame. - If you send the game message without any buttons, it will automatically have a 'Play GameName' button. When this button is pressed, your bot gets a CallbackQuery with the game_short_name of the requested game. You provide the correct URL for this particular user and the app opens the game in the in-app browser. - 'You can manually add multiple buttons to your game message. Please note that the first button in the first row must always launch the game, using the field callback_game in InlineKeyboardButton. You can add extra buttons according to taste: e.g., for a description of the rules, or to open the game''s official community.' - To make your game more attractive, you can upload a GIF animation that demostrates the game to the users via BotFather (see Lumberjack for example). - A game message will also display high scores for the current chat. Use setGameScore to post high scores to the chat with the game, add the edit_message parameter to automatically update the message with the current scoreboard. - Use getGameHighScores to get data for in-game high score tables. - You can also add an extra sharing button for users to share their best score to different chats. - For examples of what can be done using this new stuff, check the @gamebot and @gamee bots. desc: - name: blockquote content: The Bot API is an HTTP-based interface created for developers keen on building bots for Telegram.To learn how to create and set up a bot, please consult our Introduction to Bots and Bot FAQ.