description:'This object represents an incoming update.Only one of the optional parameters can be present in any given update.'
fields:
-
name:update_id
types:
- int
optional:false
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.'
-
name:message
types:
- Message
optional:true
description:'Optional. New incoming message of any kind — text, photo, sticker, etc.'
-
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.'
description:'Optional. Sender, can be 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_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:text
types:
- string
optional:true
description:'Optional. For text messages, the actual UTF-8 text of the message, 0-4096 characters.'
-
name:audio
types:
- Audio
optional:true
description:'Optional. Message is an audio file, information about the file'
-
name:document
types:
- Document
optional:true
description:'Optional. Message is a general file, information about the file'
-
name:photo
types:
- Array<PhotoSize>
optional:true
description:'Optional. Message is a photo, available sizes of the photo'
-
name:sticker
types:
- Sticker
optional:true
description:'Optional. Message is a sticker, information about the sticker'
-
name:video
types:
- Video
optional:true
description:'Optional. Message is a video, information about the video'
-
name:voice
types:
- Voice
optional:true
description:'Optional. Message is a voice message, information about the file'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption for the photo or video, 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:new_chat_participant
types:
- User
optional:true
description:'Optional. A new member was added to the group, information about them (this member may be the bot itself)'
-
name:left_chat_participant
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'
-
name:group_chat_created
types:
- bool
optional:true
description: 'Optional. Service message:the group has been created'
-
name:supergroup_chat_created
types:
- bool
optional:true
description: 'Optional. Service message:the supergroup has been created'
-
name:channel_chat_created
types:
- bool
optional:true
description: 'Optional. Service message:the channel has been created'
-
name:migrate_to_chat_id
types:
- int
optional:true
description:'Optional. The group has been migrated to a supergroup with the specified identifier, not exceeding 1e13 by absolute value'
-
name:migrate_from_chat_id
types:
- int
optional:true
description:'Optional. The supergroup has been migrated from a group with the specified identifier, not exceeding 1e13 by absolute value'
description:'This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile.'
fields:
-
name:file_id
types:
- string
optional:false
description:'Unique identifier for this file'
-
name:file_size
types:
- int
optional:true
description:'Optional. File size, if known'
-
name:file_path
types:
- string
optional:true
description:'Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.'
description:'This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).'
fields:
-
name:keyboard
types:
- Array<Array<string>>
optional:false
description:'Array of button rows, each represented by an Array of Strings'
-
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.'
-
name:one_time_keyboard
types:
- bool
optional:true
description:'Optional. Requests clients to hide the keyboard as soon as it''s been used. Defaults to false.'
-
name:selective
types:
- bool
optional:true
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:'Upon receiving a message with this object, Telegram clients will hide the current custom keyboard and display the default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).'
fields:
-
name:hide_keyboard
types:
- bool
optional:false
description:'Requests clients to hide the custom keyboard'
-
name:selective
types:
- bool
optional:true
description: 'Optional. Use this parameter if you want to hide 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 hides keyboard for that user, while still showing the keyboard with poll options to users who haven''t voted yet.'
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.'
fields:
-
name:force_reply
types:
- bool
optional:false
description:'Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'''
-
name:selective
types:
- bool
optional:true
description: 'Optional. Use this parameter if you want to force reply from specific users only. Targets:1) users that are @mentioned in the text of the Message object; 2) if the bot''s message is a reply (has reply_to_message_id), sender of the original message.'
description:'This object represents 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:'This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.'
fields:
-
name:id
types:
- string
optional:false
description:'Unique identifier for this query'
-
name:from
types:
- User
optional:false
description:Sender
-
name:query
types:
- string
optional:false
description:'Text of the query'
-
name:offset
types:
- string
optional:false
description:'Offset of the results to be returned, can be controlled by the bot'
description:'Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can provide message_text to send it instead of photo.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the result, must be photo'
-
name:id
types:
- string
optional:false
description:'Unique identifier for this result, 1-64 bytes'
-
name:photo_url
types:
- string
optional:false
description:'A valid URL of the photo. Photo must be in jpeg format. Photo size must not exceed 5MB'
-
name:photo_width
types:
- int
optional:true
description:'Optional. Width of the photo'
-
name:photo_height
types:
- int
optional:true
description:'Optional. Height of the photo'
-
name:thumb_url
types:
- string
optional:false
description:'URL of the thumbnail for the photo'
-
name:title
types:
- string
optional:true
description:'Optional. Title for the result'
-
name:description
types:
- string
optional:true
description:'Optional. Short description of the result'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the photo to be sent, 0-200 characters'
-
name:message_text
types:
- string
optional:true
description:'Optional. Text of a message to be sent instead of the photo, 1-4096 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 your bot''s message.'
-
name:disable_web_page_preview
types:
- bool
optional:true
description:'Optional. Disables link previews for links in the sent message'
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 provide message_text to send it instead of the animation.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the result, must be gif'
-
name:id
types:
- string
optional:false
description:'Unique identifier for this result, 1-64 bytes'
-
name:gif_url
types:
- string
optional:false
description:'A valid URL for the GIF file. File size must not exceed 1MB'
-
name:gif_width
types:
- int
optional:true
description:'Optional. Width of the GIF'
-
name:gif_height
types:
- int
optional:true
description:'Optional. Height of the GIF'
-
name:thumb_url
types:
- string
optional:false
description:'URL of the static thumbnail for the result (jpeg or gif)'
-
name:title
types:
- string
optional:true
description:'Optional. Title for the result'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the GIF file to be sent, 0-200 characters'
-
name:message_text
types:
- string
optional:true
description:'Optional. Text of a message to be sent instead of the animation, 1-4096 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 your bot''s message.'
-
name:disable_web_page_preview
types:
- bool
optional:true
description:'Optional. Disables link previews for links in the sent message'
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 provide message_text to send it instead of the animation.'
fields:
-
name:type
types:
- string
optional:false
description:'Type of the result, must be mpeg4_gif'
-
name:id
types:
- string
optional:false
description:'Unique identifier for this result, 1-64 bytes'
-
name:mpeg4_url
types:
- string
optional:false
description:'A valid URL for the MP4 file. File size must not exceed 1MB'
-
name:mpeg4_width
types:
- int
optional:true
description:'Optional. Video width'
-
name:mpeg4_height
types:
- int
optional:true
description:'Optional. Video height'
-
name:thumb_url
types:
- string
optional:false
description:'URL of the static thumbnail (jpeg or gif) for the result'
-
name:title
types:
- string
optional:true
description:'Optional. Title for the result'
-
name:caption
types:
- string
optional:true
description:'Optional. Caption of the MPEG-4 file to be sent, 0-200 characters'
-
name:message_text
types:
- string
optional:true
description:'Optional. Text of a message to be sent instead of the animation, 1-4096 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 your bot''s message.'
-
name:disable_web_page_preview
types:
- bool
optional:true
description:'Optional. Disables link previews for links in the sent message'
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'
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.\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:'Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.'
return_types:{}
-
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:'Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.'
description:'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide 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:'Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.'
description:'Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo using multipart/form-data.'
description:'Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.'
description:'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide 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. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data.'
description:'Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.'
description:'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide 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. You can either pass a file_id as String to resend a file that is already on the Telegram servers, or upload a new file using multipart/form-data.'
description:'Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.'
description:'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendSticker
description:'Use this method to send .webp stickers. On success, the sent Message is returned.'
description:'Sticker to send. You can either pass a file_id as String to resend a sticker that is already on the Telegram servers, or upload a new sticker using multipart/form-data.'
description:'Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.'
description:'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide 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. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file using multipart/form-data.'
description:'Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.'
description:'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide 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. You can either pass a file_id as String to resend an audio that is already on the Telegram servers, or upload a new audio file using multipart/form-data.'
description:'Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.'
description:'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.'
return_types:
- Message
-
name:sendLocation
description:'Use this method to send point on the map. On success, the sent Message is returned.'
description:'Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound. Other apps coming soon.'
description:'Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide 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). \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.'
return_types:{}
-
name:getUserProfilePhotos
description:'Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.'
description:'Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.'
return_types:
- UserProfilePhotos
-
name:getFile
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:'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.'
