"description":"Optional. 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 be forgotten.",
"description":"Optional. 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":"Optional. A JSON-serialized list of the update types you want your bot to receive. For example, specify [\"message\", \"edited_channel_post\", \"callback_query\"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.",
"description":"Optional. Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.",
"type":"text"
},
{
"key":"ip_address",
"disabled":true,
"description":"Optional. The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS",
"description":"Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.",
"description":"Optional. A JSON-serialized list of the update types you want your bot to receive. For example, specify [\"message\", \"edited_channel_post\", \"callback_query\"] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.",
"description":"Optional. A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.",
"description":"Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.\nIf you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content."
"description":"Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty."
"description":"A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object."
"description":"Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters."
"description":"Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters."
}
},
{
"name":"sendMessage",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"description":"Optional. 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 forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned."
}
},
{
"name":"forwardMessages",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"message_thread_id",
"disabled":true,
"description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
"type":"text"
},
{
"key":"from_chat_id",
"disabled":false,
"description":"Required. Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)",
"type":"text"
},
{
"key":"message_ids",
"disabled":false,
"description":"Required. Identifiers of 1-100 messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.",
"type":"text"
},
{
"key":"disable_notification",
"disabled":true,
"description":"Optional. Sends the messages silently. Users will receive a notification with no sound.",
"type":"text"
},
{
"key":"protect_content",
"disabled":true,
"description":"Optional. Protects the contents of the forwarded messages from forwarding and saving",
"description":"Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned."
"description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"description":"Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success."
}
},
{
"name":"copyMessages",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"message_thread_id",
"disabled":true,
"description":"Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
"type":"text"
},
{
"key":"from_chat_id",
"disabled":false,
"description":"Required. Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)",
"type":"text"
},
{
"key":"message_ids",
"disabled":false,
"description":"Required. Identifiers of 1-100 messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.",
"type":"text"
},
{
"key":"disable_notification",
"disabled":true,
"description":"Optional. Sends the messages silently. Users will receive a notification with no sound.",
"type":"text"
},
{
"key":"protect_content",
"disabled":true,
"description":"Optional. Protects the contents of the sent messages from forwarding and saving",
"type":"text"
},
{
"key":"remove_caption",
"disabled":true,
"description":"Optional. Pass True to copy the messages without their captions",
"description":"Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned."
"description":"Required. Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »",
"description":"Optional. 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":"Required. Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »",
"description":"Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »",
"description":"Optional. 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 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.\nFor sending voice messages, use the sendVoice method instead."
}
},
{
"name":"sendDocument",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"description":"Required. File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »",
"description":"Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »",
"description":"Optional. 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."
}
},
{
"name":"sendVideo",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"description":"Required. Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new video using multipart/form-data. More information on Sending Files »",
"description":"Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »",
"description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"description":"Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future."
"description":"Required. Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More information on Sending Files »",
"description":"Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »",
"description":"Optional. 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 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."
}
},
{
"name":"sendVoice",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"description":"Required. Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »",
"description":"Optional. 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."
}
},
{
"name":"sendVideoNote",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"description":"Required. Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files ». Sending video notes by a URL is currently unsupported",
"description":"Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »",
"description":"Optional. Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
"description":"As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned."
"description":"Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned."
}
},
{
"name":"sendLocation",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"description":"Required. Latitude of the location",
"type":"text"
},
{
"key":"longitude",
"disabled":false,
"description":"Required. Longitude of the location",
"type":"text"
},
{
"key":"horizontal_accuracy",
"disabled":true,
"description":"Optional. The radius of uncertainty for the location, measured in meters; 0-1500",
"type":"text"
},
{
"key":"live_period",
"disabled":true,
"description":"Optional. Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.",
"type":"text"
},
{
"key":"heading",
"disabled":true,
"description":"Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.",
"type":"text"
},
{
"key":"proximity_alert_radius",
"disabled":true,
"description":"Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.",
"type":"text"
},
{
"key":"disable_notification",
"disabled":true,
"description":"Optional. Sends the message silently. Users will receive a notification with no sound.",
"description":"Optional. 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":"Optional. Foursquare identifier of the venue",
"type":"text"
},
{
"key":"foursquare_type",
"disabled":true,
"description":"Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)",
"type":"text"
},
{
"key":"google_place_id",
"disabled":true,
"description":"Optional. Google Places identifier of the venue",
"type":"text"
},
{
"key":"google_place_type",
"disabled":true,
"description":"Optional. Google Places type of the venue. (See supported types.)",
"type":"text"
},
{
"key":"disable_notification",
"disabled":true,
"description":"Optional. Sends the message silently. Users will receive a notification with no sound.",
"description":"Optional. 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":"Optional. 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":"Optional. True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False",
"type":"text"
},
{
"key":"correct_option_id",
"disabled":true,
"description":"Optional. 0-based identifier of the correct answer option, required for polls in quiz mode",
"type":"text"
},
{
"key":"explanation",
"disabled":true,
"description":"Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters with at most 2 line feeds after entities parsing",
"type":"text"
},
{
"key":"explanation_parse_mode",
"disabled":true,
"description":"Optional. Mode for parsing entities in the explanation. See formatting options for more details.",
"description":"Optional. A JSON-serialized list of special entities that appear in the poll explanation, which can be specified instead of parse_mode",
"description":"Optional. Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.",
"type":"text"
},
{
"key":"close_date",
"disabled":true,
"description":"Optional. Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can't be used together with open_period.",
"description":"Optional. 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":"Optional. Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲”",
"description":"Optional. 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":"Required. Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.",
"description":"Use this method 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":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"message_id",
"disabled":false,
"description":"Required. Identifier of the target message",
"type":"text"
},
{
"key":"reaction",
"disabled":true,
"description":"Optional. New list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.",
"type":"text"
},
{
"key":"is_big",
"disabled":true,
"description":"Optional. Pass True to set the reaction with a big animation",
"description":"Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. In albums, bots must react to the first message. Returns True on success."
"description":"Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>, where <file_path> is taken from the response. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling getFile again."
"description":"Optional. Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.",
"description":"Optional. Pass True to delete all messages from the chat for the user that is being removed. If False, the user will be able to see messages in the group that were sent before the user was removed. Always True for supergroups and channels.",
"description":"Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
"description":"Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success."
}
},
{
"name":"restrictChatMember",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type":"text"
},
{
"key":"user_id",
"disabled":false,
"description":"Required. Unique identifier of the target user",
"type":"text"
},
{
"key":"permissions",
"disabled":false,
"description":"Required. A JSON-serialized object for new user permissions",
"description":"Optional. Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.",
"description":"Optional. Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever",
"description":"Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success."
"description":"Optional. Pass True if the administrator can access the chat event log, boost list in channels, see channel members, report spam messages, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege",
"description":"Optional. Pass True if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by him)",
"description":"Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success."
"description":"Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success."
"description":"Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success."
"description":"Optional. Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages and can_add_web_page_previews permissions will imply the can_send_messages, can_send_audios, can_send_documents, can_send_photos, can_send_videos, can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls permission will imply the can_send_messages permission.",
"description":"Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success."
"description":"Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success."
"description":"Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
"description":"Optional. True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified",
"description":"Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object."
"description":"Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999",
"description":"Optional. True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified",
"description":"Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object."
"description":"Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object."
}
},
{
"name":"approveChatJoinRequest",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"user_id",
"disabled":false,
"description":"Required. Unique identifier of the target user",
"description":"Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success."
}
},
{
"name":"declineChatJoinRequest",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"user_id",
"disabled":false,
"description":"Required. Unique identifier of the target user",
"description":"Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success."
"description":"Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
"description":"Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
"description":"Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
"description":"Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success."
"description":"Optional. Pass True if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels and private chats.",
"description":"Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success."
"description":"Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success."
"description":"Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success."
"description":"Use this method to get information about a member of a chat. The method is only guaranteed to work for other users if the bot is an administrator in the chat. Returns a ChatMember object on success."
"description":"Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success."
"description":"Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success."
"description":"Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects."
}
},
{
"name":"createForumTopic",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"description":"Optional. Color of the topic icon in RGB format. Currently, must be one of 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB), 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F)",
"description":"Optional. Unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers.",
"description":"Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object."
}
},
{
"name":"editForumTopic",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type":"text"
},
{
"key":"message_thread_id",
"disabled":false,
"description":"Required. Unique identifier for the target message thread of the forum topic",
"description":"Optional. New unique identifier of the custom emoji shown as the topic icon. Use getForumTopicIconStickers to get all allowed custom emoji identifiers. Pass an empty string to remove the icon. If not specified, the current icon will be kept",
"description":"Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success."
}
},
{
"name":"closeForumTopic",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type":"text"
},
{
"key":"message_thread_id",
"disabled":false,
"description":"Required. Unique identifier for the target message thread of the forum topic",
"description":"Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success."
}
},
{
"name":"reopenForumTopic",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type":"text"
},
{
"key":"message_thread_id",
"disabled":false,
"description":"Required. Unique identifier for the target message thread of the forum topic",
"description":"Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success."
}
},
{
"name":"deleteForumTopic",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type":"text"
},
{
"key":"message_thread_id",
"disabled":false,
"description":"Required. Unique identifier for the target message thread of the forum topic",
"description":"Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success."
}
},
{
"name":"unpinAllForumTopicMessages",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"type":"text"
},
{
"key":"message_thread_id",
"disabled":false,
"description":"Required. Unique identifier for the target message thread of the forum topic",
"description":"Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success."
"description":"Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success."
}
},
{
"name":"closeGeneralForumTopic",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"description":"Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success."
}
},
{
"name":"reopenGeneralForumTopic",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"description":"Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success."
}
},
{
"name":"hideGeneralForumTopic",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"description":"Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success."
}
},
{
"name":"unhideGeneralForumTopic",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
"description":"Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success."
"description":"Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success."
"description":"Optional. 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":"Optional. 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 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":"Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object."
"description":"Required. A JSON-serialized list of bot commands to be set as the list of the bot's commands. At most 100 commands can be specified.",
"type":"text"
},
{
"key":"scope",
"disabled":true,
"description":"Optional. A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.",
"description":"Optional. A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands",
"description":"Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success."
"description":"Optional. A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.",
"description":"Optional. A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands",
"description":"Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success."
}
},
{
"name":"getMyCommands",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"scope",
"disabled":true,
"description":"Optional. A JSON-serialized object, describing scope of users. Defaults to BotCommandScopeDefault.",
"description":"Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned."
"description":"Optional. New bot name; 0-64 characters. Pass an empty string to remove the dedicated name for the given language.",
"type":"text"
},
{
"key":"language_code",
"disabled":true,
"description":"Optional. A two-letter ISO 639-1 language code. If empty, the name will be shown to all users for whose language there is no dedicated name.",
"description":"Optional. New bot description; 0-512 characters. Pass an empty string to remove the dedicated description for the given language.",
"type":"text"
},
{
"key":"language_code",
"disabled":true,
"description":"Optional. A two-letter ISO 639-1 language code. If empty, the description will be applied to all users for whose language there is no dedicated description.",
"description":"Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success."
}
},
{
"name":"getMyDescription",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"language_code",
"disabled":true,
"description":"Optional. A two-letter ISO 639-1 language code or an empty string",
"description":"Use this method to get the current bot description for the given user language. Returns BotDescription on success."
}
},
{
"name":"setMyShortDescription",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"short_description",
"disabled":true,
"description":"Optional. New short description for the bot; 0-120 characters. Pass an empty string to remove the dedicated short description for the given language.",
"type":"text"
},
{
"key":"language_code",
"disabled":true,
"description":"Optional. A two-letter ISO 639-1 language code. If empty, the short description will be applied to all users for whose language there is no dedicated short description.",
"description":"Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success."
}
},
{
"name":"getMyShortDescription",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"language_code",
"disabled":true,
"description":"Optional. A two-letter ISO 639-1 language code or an empty string",
"description":"Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success."
}
},
{
"name":"setMyDefaultAdministratorRights",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"rights",
"disabled":true,
"description":"Optional. A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared.",
"type":"text"
},
{
"key":"for_channels",
"disabled":true,
"description":"Optional. Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed.",
"description":"Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success."
"description":"Optional. Pass True to get default administrator rights of the bot in channels. Otherwise, default administrator rights of the bot for groups and supergroups will be returned.",
"description":"Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"message_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Identifier of the message to edit",
"type":"text"
},
{
"key":"inline_message_id",
"disabled":true,
"description":"Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type":"text"
},
{
"key":"text",
"disabled":false,
"description":"Required. New text of the message, 1-4096 characters after entities parsing",
"type":"text"
},
{
"key":"parse_mode",
"disabled":true,
"description":"Optional. Mode for parsing entities in the message text. See formatting options for more details.",
"description":"Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned."
}
},
{
"name":"editMessageCaption",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"message_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Identifier of the message to edit",
"type":"text"
},
{
"key":"inline_message_id",
"disabled":true,
"description":"Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type":"text"
},
{
"key":"caption",
"disabled":true,
"description":"Optional. New caption of the message, 0-1024 characters after entities parsing",
"type":"text"
},
{
"key":"parse_mode",
"disabled":true,
"description":"Optional. Mode for parsing entities in the message caption. See formatting options for more details.",
"description":"Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned."
}
},
{
"name":"editMessageMedia",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"message_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Identifier of the message to edit",
"type":"text"
},
{
"key":"inline_message_id",
"disabled":true,
"description":"Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type":"text"
},
{
"key":"media",
"disabled":false,
"description":"Required. A JSON-serialized object for a new media content of the message",
"type":"text"
},
{
"key":"reply_markup",
"disabled":true,
"description":"Optional. A JSON-serialized object for a new inline keyboard.",
"description":"Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned."
"description":"Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"message_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Identifier of the message to edit",
"type":"text"
},
{
"key":"inline_message_id",
"disabled":true,
"description":"Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"description":"Required. Longitude of new location",
"type":"text"
},
{
"key":"horizontal_accuracy",
"disabled":true,
"description":"Optional. The radius of uncertainty for the location, measured in meters; 0-1500",
"type":"text"
},
{
"key":"heading",
"disabled":true,
"description":"Optional. Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.",
"type":"text"
},
{
"key":"proximity_alert_radius",
"disabled":true,
"description":"Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.",
"type":"text"
},
{
"key":"reply_markup",
"disabled":true,
"description":"Optional. A JSON-serialized object for a new inline keyboard.",
"description":"Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned."
}
},
{
"name":"stopMessageLiveLocation",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"message_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Identifier of the message with live location to stop",
"type":"text"
},
{
"key":"inline_message_id",
"disabled":true,
"description":"Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type":"text"
},
{
"key":"reply_markup",
"disabled":true,
"description":"Optional. A JSON-serialized object for a new inline keyboard.",
"description":"Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned."
}
},
{
"name":"editMessageReplyMarkup",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"message_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Identifier of the message to edit",
"type":"text"
},
{
"key":"inline_message_id",
"disabled":true,
"description":"Optional. Required if chat_id and message_id are not specified. Identifier of the inline message",
"type":"text"
},
{
"key":"reply_markup",
"disabled":true,
"description":"Optional. A JSON-serialized object for an inline keyboard.",
"description":"Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned."
}
},
{
"name":"stopPoll",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
"type":"text"
},
{
"key":"message_id",
"disabled":false,
"description":"Required. Identifier of the original message with the poll",
"type":"text"
},
{
"key":"reply_markup",
"disabled":true,
"description":"Optional. A JSON-serialized object for a new message inline keyboard.",
"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.- Service messages about a supergroup, channel, or forum topic creation can't be deleted.- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.- Bots can delete outgoing messages in private chats, groups, and supergroups.- Bots can delete incoming messages in private chats.- Bots granted can_post_messages permissions can delete outgoing messages in channels.- If the bot is an administrator of a group, it can delete any message there.- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.Returns True on success."
"description":"Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success."
"description":"Required. 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 sticker from the Internet, or upload a new .WEBP or .TGS sticker using multipart/form-data. More information on Sending Files ». Video stickers can only be sent by a file_id. Animated stickers can't be sent via an HTTP URL.",
"type":"text"
},
{
"key":"emoji",
"disabled":true,
"description":"Optional. Emoji associated with the sticker; only for just uploaded stickers",
"description":"Optional. 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":"Required. A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See https://core.telegram.org/stickers for technical requirements. More information on Sending Files »",
"description":"Use this method to upload a file with a sticker for later use in the createNewStickerSet and addStickerToSet methods (the file can be used multiple times). Returns the uploaded File on success."
"description":"Required. 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":"Optional. Pass True if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only",
"description":"Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success."
"description":"Required. A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set isn't changed.",
"description":"Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success."
"description":"Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success."
}
},
{
"name":"setStickerKeywords",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"sticker",
"disabled":false,
"description":"Required. File identifier of the sticker",
"type":"text"
},
{
"key":"keywords",
"disabled":true,
"description":"Optional. A JSON-serialized list of 0-20 search keywords for the sticker with total length of up to 64 characters",
"description":"Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success."
}
},
{
"name":"setStickerMaskPosition",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"sticker",
"disabled":false,
"description":"Required. File identifier of the sticker",
"type":"text"
},
{
"key":"mask_position",
"disabled":true,
"description":"Optional. A JSON-serialized object with the position where the mask should be placed on faces. Omit the parameter to remove the mask position.",
"description":"Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success."
}
},
{
"name":"setStickerSetTitle",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"name",
"disabled":false,
"description":"Required. Sticker set name",
"type":"text"
},
{
"key":"title",
"disabled":false,
"description":"Required. Sticker set title, 1-64 characters",
"description":"Optional. A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files ». Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.",
"description":"Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success."
}
},
{
"name":"setCustomEmojiStickerSetThumbnail",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"name",
"disabled":false,
"description":"Required. Sticker set name",
"type":"text"
},
{
"key":"custom_emoji_id",
"disabled":true,
"description":"Optional. Custom emoji identifier of a sticker from the sticker set; pass an empty string to drop the thumbnail and use the first sticker as the thumbnail.",
"description":"Optional. 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":"Optional. 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":"Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned."
"description":"Required. Three-letter ISO 4217 currency code, see more on currencies",
"type":"text"
},
{
"key":"prices",
"disabled":false,
"description":"Required. Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)",
"type":"text"
},
{
"key":"max_tip_amount",
"disabled":true,
"description":"Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0",
"type":"text"
},
{
"key":"suggested_tip_amounts",
"disabled":true,
"description":"Optional. A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.",
"type":"text"
},
{
"key":"start_parameter",
"disabled":true,
"description":"Optional. Unique deep-linking parameter. If left empty, forwarded copies of the sent message will have a Pay button, allowing multiple users to pay directly from the forwarded message, using the same invoice. If non-empty, forwarded copies of the sent message will have a URL button with a deep link to the bot (instead of a Pay button), with the value used as the start parameter",
"description":"Optional. JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.",
"description":"Optional. 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":"Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button.",
"description":"Required. Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.",
"type":"text"
},
{
"key":"provider_token",
"disabled":false,
"description":"Required. Payment provider token, obtained via BotFather",
"type":"text"
},
{
"key":"currency",
"disabled":false,
"description":"Required. Three-letter ISO 4217 currency code, see more on currencies",
"type":"text"
},
{
"key":"prices",
"disabled":false,
"description":"Required. Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)",
"type":"text"
},
{
"key":"max_tip_amount",
"disabled":true,
"description":"Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0",
"type":"text"
},
{
"key":"suggested_tip_amounts",
"disabled":true,
"description":"Optional. A JSON-serialized array of suggested amounts of tips in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.",
"type":"text"
},
{
"key":"provider_data",
"disabled":true,
"description":"Optional. JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider.",
"type":"text"
},
{
"key":"photo_url",
"disabled":true,
"description":"Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.",
"description":"Required. Pass True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)",
"description":"Optional. Required if ok is True. A JSON-serialized array of available shipping options.",
"type":"text"
},
{
"key":"error_message",
"disabled":true,
"description":"Optional. 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":"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."
}
},
{
"name":"answerPreCheckoutQuery",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"pre_checkout_query_id",
"disabled":false,
"description":"Required. Unique identifier for the query to be answered",
"type":"text"
},
{
"key":"ok",
"disabled":false,
"description":"Required. 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.",
"type":"text"
},
{
"key":"error_message",
"disabled":true,
"description":"Optional. 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":"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."
}
},
{
"name":"setPassportDataErrors",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"user_id",
"disabled":false,
"description":"Required. User identifier",
"type":"text"
},
{
"key":"errors",
"disabled":false,
"description":"Required. A JSON-serialized array describing the errors",
"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."
}
},
{
"name":"sendGame",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"chat_id",
"disabled":false,
"description":"Required. Unique identifier for the target chat",
"description":"Optional. A JSON-serialized object for an inline keyboard. If empty, one 'Play game_title' button will be shown. If not empty, the first button must launch the game.",
"description":"Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False."
}
},
{
"name":"getGameHighScores",
"request":{
"method":"POST",
"body":{
"mode":"formdata",
"formdata":[
{
"key":"user_id",
"disabled":false,
"description":"Required. Target user id",
"type":"text"
},
{
"key":"chat_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Unique identifier for the target chat",
"type":"text"
},
{
"key":"message_id",
"disabled":true,
"description":"Optional. Required if inline_message_id is not specified. Identifier of the sent message",
"type":"text"
},
{
"key":"inline_message_id",
"disabled":true,
"description":"Optional. 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 their neighbors in a game. Returns an Array of GameHighScore objects."
