"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."
"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 smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier."
"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."
"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 smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier."
"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 smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier."
"description":"Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply."
"description":"Type of the entity. Can be mention (@username), hashtag, bot_command, url, email, bold (bold text), italic (italic text), code (monowidth string), pre (monowidth block), text_link (for clickable text URLs), text_mention (for users without usernames)"
"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":"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. 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."
"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."
"description":"Optional. Description of the game that will be launched when the user presses the button.NOTE: This type of button must always be the first button in the first row."
"description":"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"
"description":"Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games."
"description":"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":"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."
"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.",
"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":"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":"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. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message."
"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."
"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."
"description":"You can provide an animation for your game so that it looks stylish in chats (check out Lumberjack for an example). This object represents an animation file to be displayed in the message containing a game.",
"description":"Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.",
"fields":[
{
"name":"offset",
"types":[
"int"
],
"required":false,
"description":"Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten."
},
{
"name":"limit",
"types":[
"int"
],
"required":false,
"description":"Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100."
},
{
"name":"timeout",
"types":[
"int"
],
"required":false,
"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":"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.",
"fields":[
{
"name":"url",
"types":[
"string"
],
"required":false,
"description":"HTTPS url to send updates to. Use an empty string to remove webhook integration"
},
{
"name":"certificate",
"types":[
"InputFile"
],
"required":false,
"description":"Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details."
"description":"Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.",
"description":"A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.",
"description":"Use this method to send text messages. On success, the sent Message is returned.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"text",
"types":[
"string"
],
"required":true,
"description":"Text of the message to be sent"
},
{
"name":"parse_mode",
"types":[
"string"
],
"required":false,
"description":"Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message."
},
{
"name":"disable_web_page_preview",
"types":[
"bool"
],
"required":false,
"description":"Disables link previews for links in this message"
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ForceReply"
],
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."
"description":"Use this method to send photos. On success, the sent Message is returned.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"photo",
"types":[
"InputFile",
"string"
],
"required":true,
"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 »"
},
{
"name":"caption",
"types":[
"string"
],
"required":false,
"description":"Photo caption (may also be used when resending photos by file_id), 0-200 characters"
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ForceReply"
],
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."
"description":"Use this method to send 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.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"audio",
"types":[
"InputFile",
"string"
],
"required":true,
"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 »"
},
{
"name":"caption",
"types":[
"string"
],
"required":false,
"description":"Audio caption, 0-200 characters"
},
{
"name":"duration",
"types":[
"int"
],
"required":false,
"description":"Duration of the audio in seconds"
},
{
"name":"performer",
"types":[
"string"
],
"required":false,
"description":"Performer"
},
{
"name":"title",
"types":[
"string"
],
"required":false,
"description":"Track name"
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ForceReply"
],
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."
"description":"Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"document",
"types":[
"InputFile",
"string"
],
"required":true,
"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 »"
},
{
"name":"caption",
"types":[
"string"
],
"required":false,
"description":"Document caption (may also be used when resending documents by file_id), 0-200 characters"
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ForceReply"
],
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."
"description":"Use this method to send .webp stickers. On success, the sent Message is returned.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"sticker",
"types":[
"InputFile",
"string"
],
"required":true,
"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 »"
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ForceReply"
],
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."
"description":"Use this method to send video files, Telegram clients support 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.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"video",
"types":[
"InputFile",
"string"
],
"required":true,
"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 »"
},
{
"name":"duration",
"types":[
"int"
],
"required":false,
"description":"Duration of sent video in seconds"
},
{
"name":"width",
"types":[
"int"
],
"required":false,
"description":"Video width"
},
{
"name":"height",
"types":[
"int"
],
"required":false,
"description":"Video height"
},
{
"name":"caption",
"types":[
"string"
],
"required":false,
"description":"Video caption (may also be used when resending videos by file_id), 0-200 characters"
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ForceReply"
],
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."
"description":"Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"voice",
"types":[
"InputFile",
"string"
],
"required":true,
"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":"Duration of the voice message in seconds"
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ForceReply"
],
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."
"description":"Use this method to send point on the map. On success, the sent Message is returned.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"latitude",
"types":[
"float"
],
"required":true,
"description":"Latitude of location"
},
{
"name":"longitude",
"types":[
"float"
],
"required":true,
"description":"Longitude of location"
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ForceReply"
],
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."
"description":"Use this method to send information about a venue. On success, the sent Message is returned.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"latitude",
"types":[
"float"
],
"required":true,
"description":"Latitude of the venue"
},
{
"name":"longitude",
"types":[
"float"
],
"required":true,
"description":"Longitude of the venue"
},
{
"name":"title",
"types":[
"string"
],
"required":true,
"description":"Name of the venue"
},
{
"name":"address",
"types":[
"string"
],
"required":true,
"description":"Address of the venue"
},
{
"name":"foursquare_id",
"types":[
"string"
],
"required":false,
"description":"Foursquare identifier of the venue"
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ForceReply"
],
"required":false,
"description":"Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user."
"description":"Use this method to send phone contacts. On success, the sent Message is returned.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"phone_number",
"types":[
"string"
],
"required":true,
"description":"Contact's phone number"
},
{
"name":"first_name",
"types":[
"string"
],
"required":true,
"description":"Contact's first name"
},
{
"name":"last_name",
"types":[
"string"
],
"required":false,
"description":"Contact's last name"
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup",
"ReplyKeyboardMarkup",
"ReplyKeyboardRemove",
"ForceReply"
],
"required":false,
"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."
"description":"Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.\nWe only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"action",
"types":[
"string"
],
"required":true,
"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."
"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 or a supergroup. In the case of supergroups, 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 group for this to work. Returns True on success.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername)"
},
{
"name":"user_id",
"types":[
"int"
],
"required":true,
"description":"Unique identifier of the target user"
"description":"Use this method to unban a previously kicked user in a supergroup. The user will not return to the group automatically, but will be able to join via link, etc. The bot must be an administrator in the group for this to work. Returns True on success.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target group or username of the target supergroup (in the format @supergroupusername)"
},
{
"name":"user_id",
"types":[
"int"
],
"required":true,
"description":"Unique identifier of the target user"
"description":"Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)"
"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.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)"
"description":"Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.",
"fields":[
{
"name":"callback_query_id",
"types":[
"string"
],
"required":true,
"description":"Unique identifier for the query to be answered"
},
{
"name":"text",
"types":[
"string"
],
"required":false,
"description":"Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters"
},
{
"name":"show_alert",
"types":[
"bool"
],
"required":false,
"description":"If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false."
},
{
"name":"url",
"types":[
"string"
],
"required":false,
"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 telegram.me/your_bot?start=XXXX that open your bot with a parameter."
},
{
"name":"cache_time",
"types":[
"int"
],
"required":false,
"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.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":false,
"description":"Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"message_id",
"types":[
"int"
],
"required":false,
"description":"Required if inline_message_id is not specified. Identifier of the sent message"
},
{
"name":"inline_message_id",
"types":[
"string"
],
"required":false,
"description":"Required if chat_id and message_id are not specified. Identifier of the inline message"
},
{
"name":"text",
"types":[
"string"
],
"required":true,
"description":"New text of the message"
},
{
"name":"parse_mode",
"types":[
"string"
],
"required":false,
"description":"Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message."
},
{
"name":"disable_web_page_preview",
"types":[
"bool"
],
"required":false,
"description":"Disables link previews for links in this message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup"
],
"required":false,
"description":"A JSON-serialized object for an inline keyboard."
"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.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":false,
"description":"Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"message_id",
"types":[
"int"
],
"required":false,
"description":"Required if inline_message_id is not specified. Identifier of the sent message"
},
{
"name":"inline_message_id",
"types":[
"string"
],
"required":false,
"description":"Required if chat_id and message_id are not specified. Identifier of the inline message"
},
{
"name":"caption",
"types":[
"string"
],
"required":false,
"description":"New caption of the message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup"
],
"required":false,
"description":"A JSON-serialized object for an inline keyboard."
"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.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":false,
"description":"Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"message_id",
"types":[
"int"
],
"required":false,
"description":"Required if inline_message_id is not specified. Identifier of the sent message"
},
{
"name":"inline_message_id",
"types":[
"string"
],
"required":false,
"description":"Required if chat_id and message_id are not specified. Identifier of the inline message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup"
],
"required":false,
"description":"A JSON-serialized object for an inline keyboard."
"description":"Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed.",
"fields":[
{
"name":"inline_query_id",
"types":[
"string"
],
"required":true,
"description":"Unique identifier for the answered query"
},
{
"name":"results",
"types":[
"Array<InlineQueryResult>"
],
"required":true,
"description":"A JSON-serialized array of results for the inline query"
},
{
"name":"cache_time",
"types":[
"int"
],
"required":false,
"description":"The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300."
},
{
"name":"is_personal",
"types":[
"bool"
],
"required":false,
"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"
},
{
"name":"next_offset",
"types":[
"string"
],
"required":false,
"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."
},
{
"name":"switch_pm_text",
"types":[
"string"
],
"required":false,
"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"
},
{
"name":"switch_pm_parameter",
"types":[
"string"
],
"required":false,
"description":"Parameter for the start message sent to the bot when user presses the switch buttonExample: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a ‘Connect your YouTube account’ button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities."
"description":"Use this method to send a game. On success, the sent Message is returned.",
"fields":[
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":true,
"description":"Unique identifier for the target chat or username of the target channel (in the format @channelusername)"
},
{
"name":"game_short_name",
"types":[
"string"
],
"required":true,
"description":"Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather."
},
{
"name":"disable_notification",
"types":[
"bool"
],
"required":false,
"description":"Sends the message silently. iOS users will not receive a notification, Android users will receive a notification with no sound."
},
{
"name":"reply_to_message_id",
"types":[
"int"
],
"required":false,
"description":"If the message is a reply, ID of the original message"
},
{
"name":"reply_markup",
"types":[
"InlineKeyboardMarkup"
],
"required":false,
"description":"A JSON-serialized object for an inline keyboard. If empty, one ‘Play game_title’ button will be shown. If not empty, the first button must launch the game."
"description":"Use this method to set the score of the specified user in a game. 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.",
"fields":[
{
"name":"user_id",
"types":[
"int"
],
"required":true,
"description":"User identifier"
},
{
"name":"score",
"types":[
"int"
],
"required":true,
"description":"New score, must be non-negative"
},
{
"name":"force",
"types":[
"bool"
],
"required":false,
"description":"Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters"
},
{
"name":"disable_edit_message",
"types":[
"bool"
],
"required":false,
"description":"Pass True, if the game message should not be automatically edited to include the current scoreboard"
},
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":false,
"description":"Required if inline_message_id is not specified. Unique identifier for the target chat (or username of the target channel in the format @channelusername)"
},
{
"name":"message_id",
"types":[
"int"
],
"required":false,
"description":"Required if inline_message_id is not specified. Identifier of the sent message"
},
{
"name":"inline_message_id",
"types":[
"string"
],
"required":false,
"description":"Required if chat_id and message_id are not specified. Identifier of the inline message"
"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.",
"fields":[
{
"name":"user_id",
"types":[
"int"
],
"required":true,
"description":"Target user id"
},
{
"name":"chat_id",
"types":[
"int",
"string"
],
"required":false,
"description":"Required if inline_message_id is not specified. Unique identifier for the target chat (or username of the target channel in the format @channelusername)"
},
{
"name":"message_id",
"types":[
"int"
],
"required":false,
"description":"Required if inline_message_id is not specified. Identifier of the sent message"
},
{
"name":"inline_message_id",
"types":[
"string"
],
"required":false,
"description":"Required if chat_id and message_id are not specified. Identifier of the inline message"
