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.'
-
name:message
types:
- Message
optional:true
description:'Optional. New incoming message of any kind — text, photo, sticker, etc.'
-
name:edited_message
types:
- Message
optional:true
description:'Optional. New version of a message that is known to the bot and was edited'
-
name:channel_post
types:
- Message
optional:true
description:'Optional. New incoming channel post of any kind — text, photo, sticker, etc.'
-
name:edited_channel_post
types:
- Message
optional:true
description:'Optional. New version of a channel post that is known to the bot and was edited'
-
name:inline_query
types:
- InlineQuery
optional:true
description:'Optional. New incoming inline query'
-
name:chosen_inline_result
types:
- ChosenInlineResult
optional:true
description:'Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.'
-
name:callback_query
types:
- CallbackQuery
optional:true
description:'Optional. New incoming callback query'
-
name:shipping_query
types:
- ShippingQuery
optional:true
description:'Optional. New incoming shipping query. Only for invoices with flexible price'
-
name:pre_checkout_query
types:
- PreCheckoutQuery
optional:true
description:'Optional. New incoming pre-checkout query. Contains full information about checkout'
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.'
-
name:type
types:
- string
optional:false
description:'Type of chat, can be either “private”, “group”, “supergroup” or “channel”'
-
name:title
types:
- string
optional:true
description:'Optional. Title, for supergroups, channels and group chats'
-
name:username
types:
- string
optional:true
description:'Optional. Username, for private chats, supergroups and channels if available'
-
name:first_name
types:
- string
optional:true
description:'Optional. First name of the other party in a private chat'
-
name:last_name
types:
- string
optional:true
description:'Optional. Last name of the other party in a private chat'
-
name:all_members_are_administrators
types:
- bool
optional:true
description:'Optional. True if a group has ‘All Members Are Admins’ enabled.'
-
name:photo
types:
- ChatPhoto
optional:true
description:'Optional. Chat photo. Returned only in getChat.'
-
name:description
types:
- string
optional:true
description:'Optional. Description, for supergroups and channel chats. Returned only in getChat.'
-
name:invite_link
types:
- string
optional:true
description:'Optional. Chat invite link, for supergroups and channel chats. Returned only in getChat.'
-
name:pinned_message
types:
- Message
optional:true
description:'Optional. Pinned message, for supergroups and channel chats. Returned only in getChat.'
-
name:sticker_set_name
types:
- string
optional:true
description:'Optional. For supergroups, name of group sticker set. Returned only in getChat.'
-
name:can_set_sticker_set
types:
- bool
optional:true
description:'Optional. True, if the bot can change the group sticker set. Returned only in getChat.'
description:'Unique message identifier inside this chat'
-
name:from
types:
- User
optional:true
description:'Optional. Sender, empty for messages sent to channels'
-
name:date
types:
- int
optional:false
description:'Date the message was sent in Unix time'
-
name:chat
types:
- Chat
optional:false
description:'Conversation the message belongs to'
-
name:forward_from
types:
- User
optional:true
description:'Optional. For forwarded messages, sender of the original message'
-
name:forward_from_chat
types:
- Chat
optional:true
description:'Optional. For messages forwarded from channels, information about the original channel'
-
name:forward_from_message_id
types:
- int
optional:true
description:'Optional. For messages forwarded from channels, identifier of the original message in the channel'
-
name:forward_signature
types:
- string
optional:true
description:'Optional. For messages forwarded from channels, signature of the post author if present'
-
name:forward_date
types:
- int
optional:true
description:'Optional. For forwarded messages, date the original message was sent in Unix time'
-
name:reply_to_message
types:
- Message
optional:true
description:'Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.'
-
name:edit_date
types:
- int
optional:true
description:'Optional. Date the message was last edited in Unix time'
-
name:media_group_id
types:
- string
optional:true
description:'Optional. The unique identifier of a media message group this message belongs to'
-
name:author_signature
types:
- string
optional:true
description:'Optional. Signature of the post author for messages in channels'
-
name:text
types:
- string
optional:true
description:'Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters.'
-
name:entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text'
-
name:caption_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption'
-
name:audio
types:
- Audio
optional:true
description:'Optional. Message is an audio file, information about the file'
-
name:document
types:
- Document
optional:true
description:'Optional. Message is a general file, information about the file'
-
name:animation
types:
- Animation
optional:true
description:'Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set'
-
name:game
types:
- Game
optional:true
description:'Optional. Message is a game, information about the game. More about games »'
-
name:photo
types:
- Array<PhotoSize>
optional:true
description:'Optional. Message is a photo, available sizes of the photo'
-
name:sticker
types:
- Sticker
optional:true
description:'Optional. Message is a sticker, information about the sticker'
-
name:video
types:
- Video
optional:true
description:'Optional. Message is a video, information about the video'
-
name:voice
types:
- Voice
optional:true
description:'Optional. Message is a voice message, information about the file'
-
name:video_note
types:
- VideoNote
optional:true
description:'Optional. Message is a video note, information about the video message'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption for the audio, document, photo, video or voice, 0-200 characters'
-
name:contact
types:
- Contact
optional:true
description:'Optional. Message is a shared contact, information about the contact'
-
name:location
types:
- Location
optional:true
description:'Optional. Message is a shared location, information about the location'
-
name:venue
types:
- Venue
optional:true
description:'Optional. Message is a venue, information about the venue'
-
name:new_chat_members
types:
- Array<User>
optional:true
description:'Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)'
-
name:left_chat_member
types:
- User
optional:true
description:'Optional. A member was removed from the group, information about them (this member may be the bot itself)'
-
name:new_chat_title
types:
- string
optional:true
description:'Optional. A chat title was changed to this value'
-
name:new_chat_photo
types:
- Array<PhotoSize>
optional:true
description:'Optional. A chat photo was change to this value'
-
name:delete_chat_photo
types:
- bool
optional:true
description: 'Optional. Service message:the chat photo was deleted'
description: 'Optional. Service message:the supergroup has been created. This field can‘t be received in a message coming through updates, because bot can’t be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.'
description: 'Optional. Service message:the channel has been created. This field can‘t be received in a message coming through updates, because bot can’t be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.'
description:'Optional. 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.'
-
name:migrate_from_chat_id
types:
- int
optional:true
description:'Optional. The supergroup has been migrated from a group with the specified identifier. This number may 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.'
-
name:pinned_message
types:
- Message
optional:true
description:'Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.'
-
name:invoice
types:
- Invoice
optional:true
description:'Optional. Message is an invoice for a payment, information about the invoice. More about payments »'
-
name:successful_payment
types:
- SuccessfulPayment
optional:true
description:'Optional. Message is a service message about a successful payment, information about the payment. More about payments »'
-
name:connected_website
types:
- string
optional:true
description:'Optional. The domain name of the website on which the user has logged in. More about Telegram Login »'
description:'This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.'
description:'Array of button rows, each represented by an Array of KeyboardButton objects'
-
name:resize_keyboard
types:
- bool
optional:true
description:'Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app''s standard keyboard.'
description:'Optional. Requests clients to hide the keyboard as soon as it''s been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false.'
description: 'Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.Example:A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.'
description:'This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields are mutually exclusive.'
description:'Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).'
description:'Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)'
description: 'Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.Example:A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven''t voted yet.'
description:'Optional. HTTP or tg:// url to be opened when button is pressed'
-
name:callback_data
types:
- string
optional:true
description:'Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes'
-
name:switch_inline_query
types:
- string
optional:true
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.'
-
name:switch_inline_query_current_chat
types:
- string
optional:true
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.'
-
name:callback_game
types:
- CallbackGame
optional:true
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.'
-
name:pay
types:
- bool
optional:true
description: 'Optional. Specify True, to send a Pay button.NOTE:This type of button must always be the first button in the first row.'
description:'This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.'
description:'Optional. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old'
-
name:inline_message_id
types:
- string
optional:true
description:'Optional. Identifier of the message sent via the bot in inline mode, that originated the query.'
-
name:chat_instance
types:
- string
optional:false
description:'Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.'
-
name:data
types:
- string
optional:true
description:'Optional. Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field.'
-
name:game_short_name
types:
- string
optional:true
description:'Optional. Short name of a Game to be returned, serves as the unique identifier for the game'
description:'Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply''). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.'
description: 'Optional. Use this parameter if you want to force reply from specific users only. Targets:1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.'
description:'The member''s status in the chat. Can be “creator”, “administrator”, “member”, “restricted”, “left” or “kicked”'
-
name:until_date
types:
- int
optional:true
description:'Optional. Restricted and kicked only. Date when restrictions will be lifted for this user, unix time'
-
name:can_be_edited
types:
- bool
optional:true
description:'Optional. Administrators only. True, if the bot is allowed to edit administrator privileges of that user'
-
name:can_change_info
types:
- bool
optional:true
description:'Optional. Administrators only. True, if the administrator can change the chat title, photo and other settings'
-
name:can_post_messages
types:
- bool
optional:true
description:'Optional. Administrators only. True, if the administrator can post in the channel, channels only'
-
name:can_edit_messages
types:
- bool
optional:true
description:'Optional. Administrators only. True, if the administrator can edit messages of other users and can pin messages, channels only'
-
name:can_delete_messages
types:
- bool
optional:true
description:'Optional. Administrators only. True, if the administrator can delete messages of other users'
-
name:can_invite_users
types:
- bool
optional:true
description:'Optional. Administrators only. True, if the administrator can invite new users to the chat'
-
name:can_restrict_members
types:
- bool
optional:true
description:'Optional. Administrators only. True, if the administrator can restrict, ban or unban chat members'
-
name:can_pin_messages
types:
- bool
optional:true
description:'Optional. Administrators only. True, if the administrator can pin messages, supergroups only'
-
name:can_promote_members
types:
- bool
optional:true
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)'
-
name:can_send_messages
types:
- bool
optional:true
description:'Optional. Restricted only. True, if the user can send text messages, contacts, locations and venues'
-
name:can_send_media_messages
types:
- bool
optional:true
description:'Optional. Restricted only. True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages'
-
name:can_send_other_messages
types:
- bool
optional:true
description:'Optional. Restricted only. True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages'
-
name:can_add_web_page_previews
types:
- bool
optional:true
description:'Optional. Restricted only. True, if user may add web page previews to his messages, implies can_send_media_messages'
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.'
-
name:retry_after
types:
- int
optional:true
description:'Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated'
description:'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the photo to be sent, 0-200 characters'
-
name:parse_mode
types:
- string
optional:true
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.'
description:'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »'
-
name:thumb
types:
- InputFile
- string
optional:true
description:'Optional. Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the video to be sent, 0-200 characters'
-
name:parse_mode
types:
- string
optional:true
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:width
types:
- int
optional:true
description:'Optional. Video width'
-
name:height
types:
- int
optional:true
description:'Optional. Video height'
-
name:duration
types:
- int
optional:true
description:'Optional. Video duration'
-
name:supports_streaming
types:
- bool
optional:true
description:'Optional. Pass True, if the uploaded video is suitable for streaming'
description:'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »'
-
name:thumb
types:
- InputFile
- string
optional:true
description:'Optional. Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the animation to be sent, 0-200 characters'
-
name:parse_mode
types:
- string
optional:true
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.'
description:'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »'
-
name:thumb
types:
- InputFile
- string
optional:true
description:'Optional. Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the audio to be sent, 0-200 characters'
-
name:parse_mode
types:
- string
optional:true
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:duration
types:
- int
optional:true
description:'Optional. Duration of the audio in seconds'
description:'File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More info on Sending Files »'
-
name:thumb
types:
- InputFile
- string
optional:true
description:'Optional. Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the document to be sent, 0-200 characters'
-
name:parse_mode
types:
- string
optional:true
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.'
description:'This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.'
description:'The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.'
-
name:x_shift
types:
- float
optional:false
description:'Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.'
-
name:y_shift
types:
- float
optional:false
description:'Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.'
-
name:scale
types:
- float
optional:false
description:'Mask scaling coefficient. For example, 2.0 means double size.'
description:'This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.'
description:'Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.'
description:'Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.'
description:'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.'
description:'Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.'
description:'Unique identifier for this result, 1-64 bytes'
-
name:video_url
types:
- string
optional:false
description:'A valid URL for the embedded video player or video file'
-
name:mime_type
types:
- string
optional:false
description:'Mime type of the content of video url, “text/html” or “video/mp4”'
-
name:thumb_url
types:
- string
optional:false
description:'URL of the thumbnail (jpeg only) for the video'
-
name:title
types:
- string
optional:false
description:'Title for the result'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the video to be sent, 0-200 characters'
-
name:parse_mode
types:
- string
optional:true
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:video_width
types:
- int
optional:true
description:'Optional. Video width'
-
name:video_height
types:
- int
optional:true
description:'Optional. Video height'
-
name:video_duration
types:
- int
optional:true
description:'Optional. Video duration in seconds'
-
name:description
types:
- string
optional:true
description:'Optional. Short description of the result'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).'
description:'Represents a link to an mp3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.'
description:'Represents a link to a voice recording in an .ogg container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.'
description:'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.'
description:'Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.'
description:'Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.'
description:'Unique identifier for this result, 1-64 Bytes'
-
name:latitude
types:
- float
optional:false
description:'Latitude of the venue location in degrees'
-
name:longitude
types:
- float
optional:false
description:'Longitude of the venue location in degrees'
-
name:title
types:
- string
optional:false
description:'Title of the venue'
-
name:address
types:
- string
optional:false
description:'Address of the venue'
-
name:foursquare_id
types:
- string
optional:true
description:'Optional. Foursquare identifier of the venue if known'
-
name:foursquare_type
types:
- string
optional:true
description:'Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)'
-
name:reply_markup
types:
- InlineKeyboardMarkup
optional:true
description:'Optional. Inline keyboard attached to the message'
-
name:input_message_content
types:
- InputMessageContent
optional:true
description:'Optional. Content of the message to be sent instead of the venue'
-
name:thumb_url
types:
- string
optional:true
description:'Optional. Url of the thumbnail for the result'
description:'Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.'
description:'Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.'
description:'Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.'
description:'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.'
description:'Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.'
description:'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.'
description:'Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.'
description:'Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.'
description:'Represents a link to an mp3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.'
description:'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:'
description:'Optional. Foursquare identifier of the venue, if known'
-
name:foursquare_type
types:
- string
optional:true
description:'Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)'
description:'The unique identifier for the result that was chosen'
-
name:from
types:
- User
optional:false
description:'The user that chose the result'
-
name:location
types:
- Location
optional:true
description:'Optional. Sender location, only for bots that require user location'
-
name:inline_message_id
types:
- string
optional:true
description:'Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.'
-
name:query
types:
- string
optional:false
description:'The query that was used to obtain the result'
description:'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).'
description:'Unique bot deep-linking parameter that can be used to generate this invoice'
-
name:currency
types:
- string
optional:false
description:'Three-letter ISO 4217 currency code'
-
name:total_amount
types:
- int
optional:false
description:'Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).'
description:'Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).'
-
name:invoice_payload
types:
- string
optional:false
description:'Bot specified invoice payload'
-
name:shipping_option_id
types:
- string
optional:true
description:'Optional. Identifier of the shipping option chosen by the user'
-
name:order_info
types:
- OrderInfo
optional:true
description:'Optional. Order info provided by the user'
description:'Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).'
-
name:invoice_payload
types:
- string
optional:false
description:'Bot specified invoice payload'
-
name:shipping_option_id
types:
- string
optional:true
description:'Optional. Identifier of the shipping option chosen by the user'
-
name:order_info
types:
- OrderInfo
optional:true
description:'Optional. Order info provided by the user'
description:'This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don''t exceed 10MB.'
description:'Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.'
-
name:data
types:
- string
optional:true
description:'Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “identity_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.'
-
name:phone_number
types:
- string
optional:true
description:'Optional. User''s verified phone number, available only for “phone_number” type'
-
name:email
types:
- string
optional:true
description:'Optional. User''s verified email address, available only for “email” type'
-
name:files
types:
- Array<PassportFile>
optional:true
description:'Optional. Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.'
-
name:front_side
types:
- PassportFile
optional:true
description:'Optional. Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.'
-
name:reverse_side
types:
- PassportFile
optional:true
description:'Optional. Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.'
-
name:selfie
types:
- PassportFile
optional:true
description:'Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.'
description:'Contains data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.'
description:'Base64-encoded encrypted JSON-serialized data with unique user''s payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication'
-
name:hash
types:
- string
optional:false
description:'Base64-encoded data hash for data authentication'
-
name:secret
types:
- string
optional:false
description:'Base64-encoded secret, encrypted with the bot''s public RSA key, required for data decryption'
description:'This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:'
description:'Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field''s value changes.'
description:'The section of the user''s Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”'
-
name:field_name
types:
- string
optional:false
description:'Name of the data field which has the error'
description:'Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.'
description:'The section of the user''s Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”'
-
name:file_hash
types:
- string
optional:false
description:'Base64-encoded hash of the file with the front side of the document'
description:'Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.'
description:'The section of the user''s Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”'
-
name:file_hash
types:
- string
optional:false
description:'Base64-encoded hash of the file with the selfie'
description:'The section of the user''s Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”'
description:'The section of the user''s Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”'
description:'Photo that will be displayed in the game message in chats.'
-
name:text
types:
- string
optional:true
description:'Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.'
-
name:text_entities
types:
- Array<MessageEntity>
optional:true
description:'Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.'
-
name:animation
types:
- Animation
optional:true
description:'Optional. Animation that will be displayed in the game message in chats. Upload via BotFather'
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.'
description:'Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should be positive, short polling should be used for testing purposes only.'
description:'List the types of updates 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.'
return_types:
- Array<Update>
-
name:setWebhook
description:"Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.\nIf you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. https://www.example.com/<token>. Since nobody else knows your bot‘s token, you can be pretty sure it’s us."
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.'
description:'List the types of updates 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.'
return_types:
- bool
-
name:deleteWebhook
description:'Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters.'
fields:{}
return_types:
- bool
-
name:getWebhookInfo
description:'Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.'
fields:{}
return_types:
- WebhookInfo
-
name:getMe
description:'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.'
fields:{}
return_types:
- User
-
name:sendMessage
description:'Use this method to send text messages. On success, the sent Message is returned.'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:forwardMessage
description:'Use this method to forward messages of any kind. On success, the sent Message is returned.'
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 »'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendAudio
description:"Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .mp3 format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.\nFor sending voice messages, use the sendVoice method instead."
description:'Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »'
description:'Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendDocument
description:'Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.'
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 »'
description:'Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendVideo
description:'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.'
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 »'
description:'Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendAnimation
description:'Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.'
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 »'
description:'Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendVoice
description:'Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.'
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 »'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendVideoNote
description:'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.'
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'
description:'Thumbnail of the file sent. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail‘s width and height should not exceed 90. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More info on Sending Files »'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendMediaGroup
description:'Use this method to send a group of photos or videos as an album. On success, an array of the sent Messages is returned.'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:editMessageLiveLocation
description:'Use this method to edit live location messages sent by the bot or via the bot (for inline bots). 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.'
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)'
description:'A JSON-serialized object for a new inline keyboard.'
return_types:
- Message
- bool
-
name:stopMessageLiveLocation
description:'Use this method to stop updating a live location message sent by the bot or via the bot (for inline bots) before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.'
description:'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendContact
description:'Use this method to send phone contacts. On success, the sent Message is returned.'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendChatAction
description:"Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.\nWe only recommend using this method when a response from the bot will take a noticeable amount of time to arrive."
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.'
return_types:
- bool
-
name:getUserProfilePhotos
description:'Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.'
description:'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<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again.'
description:'Use this method to 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.'
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'
return_types:
- bool
-
name:unbanChatMember
description:'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.'
description:'Unique identifier of the target user'
return_types:
- bool
-
name:restrictChatMember
description:'Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all boolean parameters to lift restrictions from a user. Returns True on success.'
description:'Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever'
description:'Pass True, if the user may add web page previews to their messages, implies can_send_media_messages'
return_types:
- bool
-
name:promoteChatMember
description:'Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.'
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)'
return_types:
- bool
-
name:exportChatInviteLink
description:'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.'
description:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
return_types:
- string
-
name:setChatPhoto
description:'Use this method to set a new profile photo for the chat. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.'
description:'New chat photo, uploaded using multipart/form-data'
return_types:
- bool
-
name:deleteChatPhoto
description:'Use this method to delete a chat photo. Photos can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.'
description:'Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
return_types:
- bool
-
name:setChatTitle
description:'Use this method to change the title of a chat. Titles can''t be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.'
description:'Use this method to change the description of a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.'
description:'Use this method to pin a message in 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.'
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.'
return_types:
- bool
-
name:unpinChatMessage
description:'Use this method to unpin a message in 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.'
description:'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)'
return_types:
- bool
-
name:getChat
description:'Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.'
description:'Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)'
return_types:
- Chat
-
name:getChatAdministrators
description:'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.'
description:'Unique identifier of the target user'
return_types:
- ChatMember
-
name:setChatStickerSet
description:'Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate 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.'
description:'Name of the sticker set to be set as the group sticker set'
return_types:
- bool
-
name:deleteChatStickerSet
description:'Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate 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.'
description:'Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)'
return_types:
- bool
-
name:answerCallbackQuery
description:'Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.'
description:'URL that will be opened by the user''s client. If you have created a Game and accepted the conditions via @Botfather, specify the URL that opens your game – note that this will only work if the query comes from a callback_game button.Otherwise, you may use links like t.me/your_bot?start=XXXX that open your bot with a parameter.'
description:'The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.'
description:'Use this method to edit text and game messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.'
description:'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
description:'A JSON-serialized object for an inline keyboard.'
return_types:
- Message
- bool
-
name:editMessageCaption
description:'Use this method to edit captions of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.'
description:'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
description:'A JSON-serialized object for an inline keyboard.'
return_types:
- Message
- bool
-
name:editMessageMedia
description:'Use this method to edit 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.'
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)'
description:'Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots). On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.'
description:'Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)'
description:'A JSON-serialized object for an inline keyboard.'
return_types:
- Message
- bool
-
name:deleteMessage
description:'Use this method to delete a message, including service messages, with the following limitations:- A message can only be deleted if it was sent less than 48 hours ago.- Bots can delete outgoing messages in groups and supergroups.- Bots granted can_post_messages permissions can delete outgoing messages in channels.- If the bot is an administrator of a group, it can delete any message there.- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.Returns True on success.'
description:'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 »'
description:'Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.'
return_types:
- Message
-
name:getStickerSet
description:'Use this method to get a sticker set. On success, a StickerSet object is returned.'
description:'Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.'
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 »'
return_types:
- File
-
name:createNewStickerSet
description:'Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. Returns True on success.'
description:'Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can''t contain consecutive underscores and must end in “_by_<bot username>”. <bot_username> is case insensitive. 1-64 characters.'
description:'Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »'
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 »'
description:'Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query'
description:'Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.'
description:'If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter'
description: 'Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.Example:An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot''s inline capabilities.'
return_types:
- bool
-
name:sendInvoice
description:'Use this method to send invoices. On success, the sent Message is returned.'
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.'
description:'URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for.'
description:'A JSON-serialized object for an inline keyboard. If empty, one ''Pay total price'' button will be shown. If not empty, the first button must be a Pay button.'
return_types:
- Message
-
name:answerShippingQuery
description:'If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.'
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)'
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.'
description: 'Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note:The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.'
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.'
description:'Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different color or garment!"). Telegram will display this message to the user.'
description:"Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.\nUse this if the data submitted by the user doesn't satisfy the standards your service requires for any reason. For example, if a birthday date seems invalid, a submitted document is blurry, a scan shows evidence of tampering, etc. Supply some details in the error message to make sure the user knows how to correct the issues."
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.'
return_types:
- Message
-
name:setGameScore
description:'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.'
description:'Required if chat_id and message_id are not specified. Identifier of the inline message'
return_types:
- Message
- bool
-
name:getGameHighScores
description:'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.'
