{ "source": "https://gist.githubusercontent.com/CyberXCoding/e84149946ad8ff0ee7dc4e62a9bc53cc/raw/4b2b23337a741c14b834763b812928472d3db04a/gistfile1.txt", "docsBase": "https://core.telegram.org/bots/api", "query": { "q": "", "type": "method", "exact": false, "limit": 20, "offset": 0 }, "total": 169, "count": 20, "results": [ { "name": "getUpdates", "kind": "method", "section": "Getting updates", "link": "https://core.telegram.org/bots/api#getupdates", "description": "Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects. Notes1. This method will not work if an outgoing webhook is set up.2. In order to avoid ge...", "fullDescription": "Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects. Notes1. This method will not work if an outgoing webhook is set up.2. In order to avoid getting duplicate updates, recalculate offset after each server response." }, { "name": "setWebhook", "kind": "method", "section": "Getting updates", "link": "https://core.telegram.org/bots/api#setwebhook", "description": "Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a...", "fullDescription": "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 (a request with response HTTP status code different from 2XY), we will repeat the request and give up after a reasonable amount of attempts. Returns True on success. If 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. Notes1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.2. To use a self-signed certificate, you need to upload your public key certificate using certificate parameter. Please upload as InputFile, sending a String will not work.3. Ports currently supported for webhooks: 443, 80, 88, 8443." }, { "name": "deleteWebhook", "kind": "method", "section": "Getting updates", "link": "https://core.telegram.org/bots/api#deletewebhook", "description": "Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.", "fullDescription": "Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success." }, { "name": "getWebhookInfo", "kind": "method", "section": "Getting updates", "link": "https://core.telegram.org/bots/api#getwebhookinfo", "description": "Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.", "fullDescription": "Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty." }, { "name": "getMe", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#getme", "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.", "fullDescription": "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." }, { "name": "logOut", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#logout", "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 rece...", "fullDescription": "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." }, { "name": "close", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#close", "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 af...", "fullDescription": "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", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#sendmessage", "description": "Use this method to send text messages. On success, the sent Message is returned.", "fullDescription": "Use this method to send text messages. On success, the sent Message is returned." }, { "name": "forwardMessage", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#forwardmessage", "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.", "fullDescription": "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", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#forwardmessages", "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...", "fullDescription": "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." }, { "name": "copyMessage", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#copymessage", "description": "Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied on...", "fullDescription": "Use this method to copy messages of any kind. Service messages, paid media 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", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#copymessages", "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, paid media messages, giveaway messages, giveaway winner...", "fullDescription": "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, paid media 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." }, { "name": "sendPhoto", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#sendphoto", "description": "Use this method to send photos. On success, the sent Message is returned.", "fullDescription": "Use this method to send photos. On success, the sent Message is returned." }, { "name": "sendAudio", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#sendaudio", "description": "Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots ...", "fullDescription": "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. For sending voice messages, use the sendVoice method instead." }, { "name": "sendDocument", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#senddocument", "description": "Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.", "fullDescription": "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", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#sendvideo", "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 ...", "fullDescription": "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." }, { "name": "sendAnimation", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#sendanimation", "description": "Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this...", "fullDescription": "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", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#sendvoice", "description": "Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3...", "fullDescription": "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, or in .MP3 format, or in .M4A format (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", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#sendvideonote", "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.", "fullDescription": "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." }, { "name": "sendPaidMedia", "kind": "method", "section": "Available methods", "link": "https://core.telegram.org/bots/api#sendpaidmedia", "description": "Use this method to send paid media. On success, the sent Message is returned.", "fullDescription": "Use this method to send paid media. On success, the sent Message is returned." } ] }