Word of caution: this documentation is generated automatically from https://core.telegram.org/bots/api and can be incomplete or wrongly formatted. Also this documentation do not contain information about general principles of the Telegram API and response objects. So, if you have any doubts, consult original api documentation and consider it as a ground truth. These docs were generated only for simpler navigation and better help hints in REPL and editors.
Please notice that this package implements the Bot API. The Telegram Bot API is an API specifically for bots, which is simpler but less customisable. It acts as an intermediary between bots and the Telegram API which allow you to build your own customized Telegram clients.
All API functions have TelegramClient
as optional positional argument, which means that if it is not set explicitly, than global client is used, which is usually created during initial construction or by explicit call of useglobally!
function.
All arguments usually have String
/Boolean
/Integer
types which is in one to one correspondence with julian types. Special arguments like document
, photo
and the like, which are intended for file sending, can accept either IOStream
argument as in open("picture.png", "r")
or Pair{String, IO}
in case of in-memory IO
objects without names. Read Usage for additional info.
API Reference
Getting updates
Telegram.API.getUpdates
— FunctiongetUpdates([tg::TelegramClient]; kwargs...)
Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
Optional arguments
offset
: (Integer) 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 asgetUpdates
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.limit
: (Integer) Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.timeout
: (Integer) 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.allowed_updates
: (Array of String) A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “editedchannelpost”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted updates may be received for a short period of time.
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.
Telegram.API.setWebhook
— FunctionsetWebhook([tg::TelegramClient]; kwargs...)
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.
If 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.
Required arguments
url
: (String) HTTPS url to send updates to. Use an empty string to remove webhook integration
Optional arguments
certificate
: (InputFile) Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.ip_address
: (String) The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNSmax_connections
: (Integer) 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.allowed_updates
: (Array of String) A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “editedchannelpost”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used.Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.drop_pending_updates
: (Boolean) Pass True to drop all pending updates
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.
NEW! If you're having any trouble setting up webhooks, please check out this amazing guide to Webhooks.
Telegram.API.deleteWebhook
— FunctiondeleteWebhook([tg::TelegramClient]; kwargs...)
Use this method to remove webhook integration if you decide to switch back to getUpdates
. Returns True on success.
Optional arguments
drop_pending_updates
: (Boolean) Pass True to drop all pending updates
Telegram.API.getWebhookInfo
— FunctiongetWebhookInfo([tg::TelegramClient]; kwargs...)
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.
Available methods
Telegram.getMe
Telegram.logOut
Telegram.close
Telegram.sendMessage
Telegram.forwardMessage
Telegram.copyMessage
Telegram.sendPhoto
Telegram.sendAudio
Telegram.sendDocument
Telegram.sendVideo
Telegram.sendAnimation
Telegram.sendVoice
Telegram.sendVideoNote
Telegram.sendMediaGroup
Telegram.sendLocation
Telegram.editMessageLiveLocation
Telegram.stopMessageLiveLocation
Telegram.sendVenue
Telegram.sendContact
Telegram.sendPoll
Telegram.sendDice
Telegram.sendChatAction
Telegram.getUserProfilePhotos
Telegram.getFile
Telegram.kickChatMember
Telegram.unbanChatMember
Telegram.restrictChatMember
Telegram.promoteChatMember
Telegram.setChatAdministratorCustomTitle
Telegram.setChatPermissions
Telegram.exportChatInviteLink
Telegram.setChatPhoto
Telegram.deleteChatPhoto
Telegram.setChatTitle
Telegram.setChatDescription
Telegram.pinChatMessage
Telegram.unpinChatMessage
Telegram.unpinAllChatMessages
Telegram.leaveChat
Telegram.getChat
Telegram.getChatAdministrators
Telegram.getChatMembersCount
Telegram.getChatMember
Telegram.setChatStickerSet
Telegram.deleteChatStickerSet
Telegram.answerCallbackQuery
Telegram.setMyCommands
Telegram.getMyCommands
Telegram.API.getMe
— FunctiongetMe([tg::TelegramClient]; kwargs...)
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.
Telegram.API.logOut
— FunctionlogOut([tg::TelegramClient]; kwargs...)
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.
Missing docstring for close
. Check Documenter's build log for details.
Telegram.API.sendMessage
— FunctionsendMessage([tg::TelegramClient]; kwargs...)
Use this method to send text messages. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)text
: (String) Text of the message to be sent, 1-4096 characters after entities parsing
Optional arguments
parse_mode
: (String) Mode for parsing entities in the message text. See formatting options for more details.entities
: (Array of MessageEntity) List of special entities that appear in message text, which can be specified instead of parse_modedisable_web_page_preview
: (Boolean) Disables link previews for links in this messagedisable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.forwardMessage
— FunctionforwardMessage([tg::TelegramClient]; kwargs...)
Use this method to forward messages of any kind. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)from_chat_id
: (Integer or String) Unique identifier for the chat where the original message was sent (or channel username in the format@channelusername
)message_id
: (Integer) Message identifier in the chat specified in fromchatid
Optional arguments
disable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.
Telegram.API.copyMessage
— FunctioncopyMessage([tg::TelegramClient]; kwargs...)
Use this method to copy messages of any kind. The method is analogous to the method forwardMessages, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)from_chat_id
: (Integer or String) Unique identifier for the chat where the original message was sent (or channel username in the format@channelusername
)message_id
: (Integer) Message identifier in the chat specified in fromchatid
Optional arguments
caption
: (String) New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is keptparse_mode
: (String) Mode for parsing entities in the new caption. See formatting options for more details.caption_entities
: (Array of MessageEntity) List of special entities that appear in the new caption, which can be specified instead of parse_modedisable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendPhoto
— FunctionsendPhoto([tg::TelegramClient]; kwargs...)
Use this method to send photos. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)photo
: (InputFile or String) 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 info on Sending Files »
Optional arguments
caption
: (String) Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsingparse_mode
: (String) Mode for parsing entities in the photo caption. See formatting options for more details.caption_entities
: (Array of MessageEntity) List of special entities that appear in the caption, which can be specified instead of parse_modedisable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendAudio
— FunctionsendAudio([tg::TelegramClient]; kwargs...)
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.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)audio
: (InputFile or String) 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 »
Optional arguments
caption
: (String) Audio caption, 0-1024 characters after entities parsingparse_mode
: (String) Mode for parsing entities in the audio caption. See formatting options for more details.caption_entities
: (Array of MessageEntity) List of special entities that appear in the caption, which can be specified instead of parse_modeduration
: (Integer) Duration of the audio in secondsperformer
: (String) Performertitle
: (String) Track namethumb
: (InputFile or String) 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://<fileattachname>” if the thumbnail was uploaded using multipart/form-data under <fileattachname>. More info on Sending Files »disable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendDocument
— FunctionsendDocument([tg::TelegramClient]; kwargs...)
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.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)document
: (InputFile or String) 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 »
Optional arguments
thumb
: (InputFile or String) 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://<fileattachname>” if the thumbnail was uploaded using multipart/form-data under <fileattachname>. More info on Sending Files »caption
: (String) Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsingparse_mode
: (String) Mode for parsing entities in the document caption. See formatting options for more details.caption_entities
: (Array of MessageEntity) List of special entities that appear in the caption, which can be specified instead of parse_modedisable_content_type_detection
: (Boolean) Disables automatic server-side content type detection for files uploaded using multipart/form-datadisable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendVideo
— FunctionsendVideo([tg::TelegramClient]; kwargs...)
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.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)video
: (InputFile or String) 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 »
Optional arguments
duration
: (Integer) Duration of sent video in secondswidth
: (Integer) Video widthheight
: (Integer) Video heightthumb
: (InputFile or String) 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://<fileattachname>” if the thumbnail was uploaded using multipart/form-data under <fileattachname>. More info on Sending Files »caption
: (String) Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsingparse_mode
: (String) Mode for parsing entities in the video caption. See formatting options for more details.caption_entities
: (Array of MessageEntity) List of special entities that appear in the caption, which can be specified instead of parse_modesupports_streaming
: (Boolean) Pass True, if the uploaded video is suitable for streamingdisable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendAnimation
— FunctionsendAnimation([tg::TelegramClient]; kwargs...)
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.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)animation
: (InputFile or String) Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. More info on Sending Files »
Optional arguments
duration
: (Integer) Duration of sent animation in secondswidth
: (Integer) Animation widthheight
: (Integer) Animation heightthumb
: (InputFile or String) 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://<fileattachname>” if the thumbnail was uploaded using multipart/form-data under <fileattachname>. More info on Sending Files »caption
: (String) Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsingparse_mode
: (String) Mode for parsing entities in the animation caption. See formatting options for more details.caption_entities
: (Array of MessageEntity) List of special entities that appear in the caption, which can be specified instead of parse_modedisable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendVoice
— FunctionsendVoice([tg::TelegramClient]; kwargs...)
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.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)voice
: (InputFile or String) 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 »
Optional arguments
caption
: (String) Voice message caption, 0-1024 characters after entities parsingparse_mode
: (String) Mode for parsing entities in the voice message caption. See formatting options for more details.caption_entities
: (Array of MessageEntity) List of special entities that appear in the caption, which can be specified instead of parse_modeduration
: (Integer) Duration of the voice message in secondsdisable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendVideoNote
— FunctionsendVideoNote([tg::TelegramClient]; kwargs...)
As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)video_note
: (InputFile or String) Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More info on Sending Files ». Sending video notes by a URL is currently unsupported
Optional arguments
duration
: (Integer) Duration of sent video in secondslength
: (Integer) Video width and height, i.e. diameter of the video messagethumb
: (InputFile or String) 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://<fileattachname>” if the thumbnail was uploaded using multipart/form-data under <fileattachname>. More info on Sending Files »disable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendMediaGroup
— FunctionsendMediaGroup([tg::TelegramClient]; kwargs...)
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.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)media
: (Array of InputMediaAudio, InputMediaDocument, InputMediaPhoto and InputMediaVideo) A JSON-serialized array describing messages to be sent, must include 2-10 items
Optional arguments
disable_notification
: (Boolean) Sends messages silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the messages are a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not found
Telegram.API.sendLocation
— FunctionsendLocation([tg::TelegramClient]; kwargs...)
Use this method to send point on the map. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)latitude
: (Float number) Latitude of the locationlongitude
: (Float number) Longitude of the location
Optional arguments
horizontal_accuracy
: (Float number) The radius of uncertainty for the location, measured in meters; 0-1500live_period
: (Integer) Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400.heading
: (Integer) For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.proximity_alert_radius
: (Integer) For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.disable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.editMessageLiveLocation
— FunctioneditMessageLiveLocation([tg::TelegramClient]; kwargs...)
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.
Required arguments
latitude
: (Float number) Latitude of new locationlongitude
: (Float number) Longitude of new location
Optional arguments
chat_id
: (Integer or String) Required if inlinemessageid is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
)message_id
: (Integer) Required if inlinemessageid is not specified. Identifier of the message to editinline_message_id
: (String) Required if chatid and messageid are not specified. Identifier of the inline messagehorizontal_accuracy
: (Float number) The radius of uncertainty for the location, measured in meters; 0-1500heading
: (Integer) Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.proximity_alert_radius
: (Integer) Maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.reply_markup
: (InlineKeyboardMarkup) A JSON-serialized object for a new inline keyboard.
Telegram.API.stopMessageLiveLocation
— FunctionstopMessageLiveLocation([tg::TelegramClient]; kwargs...)
Use this method to stop updating a live location message before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.
Optional arguments
chat_id
: (Integer or String) Required if inlinemessageid is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
)message_id
: (Integer) Required if inlinemessageid is not specified. Identifier of the message with live location to stopinline_message_id
: (String) Required if chatid and messageid are not specified. Identifier of the inline messagereply_markup
: (InlineKeyboardMarkup) A JSON-serialized object for a new inline keyboard.
Telegram.API.sendVenue
— FunctionsendVenue([tg::TelegramClient]; kwargs...)
Use this method to send information about a venue. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)latitude
: (Float number) Latitude of the venuelongitude
: (Float number) Longitude of the venuetitle
: (String) Name of the venueaddress
: (String) Address of the venue
Optional arguments
foursquare_id
: (String) Foursquare identifier of the venuefoursquare_type
: (String) Foursquare type of the venue, if known. (For example, “artsentertainment/default”, “artsentertainment/aquarium” or “food/icecream”.)google_place_id
: (String) Google Places identifier of the venuegoogle_place_type
: (String) Google Places type of the venue. (See supported types.)disable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendContact
— FunctionsendContact([tg::TelegramClient]; kwargs...)
Use this method to send phone contacts. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)phone_number
: (String) Contact's phone numberfirst_name
: (String) Contact's first name
Optional arguments
last_name
: (String) Contact's last namevcard
: (String) Additional data about the contact in the form of a vCard, 0-2048 bytesdisable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendPoll
— FunctionsendPoll([tg::TelegramClient]; kwargs...)
Use this method to send a native poll. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)question
: (String) Poll question, 1-300 charactersoptions
: (Array of String) A JSON-serialized list of answer options, 2-10 strings 1-100 characters each
Optional arguments
is_anonymous
: (Boolean) True, if the poll needs to be anonymous, defaults to Truetype
: (String) Poll type, “quiz” or “regular”, defaults to “regular”allows_multiple_answers
: (Boolean) True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to Falsecorrect_option_id
: (Integer) 0-based identifier of the correct answer option, required for polls in quiz modeexplanation
: (String) 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 parsingexplanation_parse_mode
: (String) Mode for parsing entities in the explanation. See formatting options for more details.explanation_entities
: (Array of MessageEntity) List of special entities that appear in the poll explanation, which can be specified instead of parse_modeopen_period
: (Integer) Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.close_date
: (Integer) 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.is_closed
: (Boolean) Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.disable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendDice
— FunctionsendDice([tg::TelegramClient]; kwargs...)
Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)
Optional arguments
emoji
: (String) 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 “”disable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.sendChatAction
— FunctionsendChatAction([tg::TelegramClient]; kwargs...)
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.
Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction
with action = upload_photo. The user will see a “sending photo” status for the bot.
We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)action
: (String) Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, uploadphoto for photos, recordvideo or uploadvideo for videos, recordvoice or uploadvoice for voice notes, uploaddocument for general files, findlocation for location data, recordvideonote or uploadvideo_note for video notes.
Telegram.API.getUserProfilePhotos
— FunctiongetUserProfilePhotos([tg::TelegramClient]; kwargs...)
Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
Required arguments
user_id
: (Integer) Unique identifier of the target user
Optional arguments
offset
: (Integer) Sequential number of the first photo to be returned. By default, all photos are returned.limit
: (Integer) Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.
Telegram.API.getFile
— FunctiongetFile([tg::TelegramClient]; kwargs...)
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.
Required arguments
file_id
: (String) File identifier to get info about
Note: This function may not preserve the original file name and MIME type. You should save the file's MIME type and name (if available) when the File object is received.
Telegram.API.kickChatMember
— FunctionkickChatMember([tg::TelegramClient]; kwargs...)
Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the 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 admin rights. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target group or username of the target supergroup or channel (in the format@channelusername
)user_id
: (Integer) Unique identifier of the target user
Optional arguments
until_date
: (Integer) 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.
Telegram.API.unbanChatMember
— FunctionunbanChatMember([tg::TelegramClient]; kwargs...)
Use this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. 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 onlyifbanned. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target group or username of the target supergroup or channel (in the format@username
)user_id
: (Integer) Unique identifier of the target user
Optional arguments
only_if_banned
: (Boolean) Do nothing if the user is not banned
Telegram.API.restrictChatMember
— FunctionrestrictChatMember([tg::TelegramClient]; kwargs...)
Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate admin rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
)user_id
: (Integer) Unique identifier of the target userpermissions
: (ChatPermissions) A JSON-serialized object for new user permissions
Optional arguments
until_date
: (Integer) 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
Telegram.API.promoteChatMember
— FunctionpromoteChatMember([tg::TelegramClient]; kwargs...)
Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)user_id
: (Integer) Unique identifier of the target user
Optional arguments
is_anonymous
: (Boolean) Pass True, if the administrator's presence in the chat is hiddencan_change_info
: (Boolean) Pass True, if the administrator can change chat title, photo and other settingscan_post_messages
: (Boolean) Pass True, if the administrator can create channel posts, channels onlycan_edit_messages
: (Boolean) Pass True, if the administrator can edit messages of other users and can pin messages, channels onlycan_delete_messages
: (Boolean) Pass True, if the administrator can delete messages of other userscan_invite_users
: (Boolean) Pass True, if the administrator can invite new users to the chatcan_restrict_members
: (Boolean) Pass True, if the administrator can restrict, ban or unban chat memberscan_pin_messages
: (Boolean) Pass True, if the administrator can pin messages, supergroups onlycan_promote_members
: (Boolean) Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him)
Telegram.API.setChatAdministratorCustomTitle
— FunctionsetChatAdministratorCustomTitle([tg::TelegramClient]; kwargs...)
Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
)user_id
: (Integer) Unique identifier of the target usercustom_title
: (String) New custom title for the administrator; 0-16 characters, emoji are not allowed
Telegram.API.setChatPermissions
— FunctionsetChatPermissions([tg::TelegramClient]; kwargs...)
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 canrestrictmembers admin rights. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
)permissions
: (ChatPermissions) New default chat permissions
Telegram.API.exportChatInviteLink
— FunctionexportChatInviteLink([tg::TelegramClient]; kwargs...)
Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)
Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink
— after this the link will become available to the bot via the getChat
method. If your bot needs to generate a new invite link replacing its previous one, use exportChatInviteLink
again.
Telegram.API.setChatPhoto
— FunctionsetChatPhoto([tg::TelegramClient]; kwargs...)
Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)photo
: (InputFile) New chat photo, uploaded using multipart/form-data
Telegram.API.deleteChatPhoto
— FunctiondeleteChatPhoto([tg::TelegramClient]; kwargs...)
Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)
Telegram.API.setChatTitle
— FunctionsetChatTitle([tg::TelegramClient]; kwargs...)
Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)title
: (String) New chat title, 1-255 characters
Telegram.API.setChatDescription
— FunctionsetChatDescription([tg::TelegramClient]; kwargs...)
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 admin rights. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)
Optional arguments
description
: (String) New chat description, 0-255 characters
Telegram.API.pinChatMessage
— FunctionpinChatMessage([tg::TelegramClient]; kwargs...)
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 'canpinmessages' admin right in a supergroup or 'caneditmessages' admin right in a channel. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)message_id
: (Integer) Identifier of a message to pin
Optional arguments
disable_notification
: (Boolean) 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.
Telegram.API.unpinChatMessage
— FunctionunpinChatMessage([tg::TelegramClient]; kwargs...)
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 'canpinmessages' admin right in a supergroup or 'caneditmessages' admin right in a channel. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)
Optional arguments
message_id
: (Integer) Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.
Telegram.API.unpinAllChatMessages
— FunctionunpinAllChatMessages([tg::TelegramClient]; kwargs...)
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 'canpinmessages' admin right in a supergroup or 'caneditmessages' admin right in a channel. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)
Telegram.API.leaveChat
— FunctionleaveChat([tg::TelegramClient]; kwargs...)
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target supergroup or channel (in the format@channelusername
)
Telegram.API.getChat
— FunctiongetChat([tg::TelegramClient]; kwargs...)
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.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target supergroup or channel (in the format@channelusername
)
Telegram.API.getChatAdministrators
— FunctiongetChatAdministrators([tg::TelegramClient]; kwargs...)
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.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target supergroup or channel (in the format@channelusername
)
Telegram.API.getChatMembersCount
— FunctiongetChatMembersCount([tg::TelegramClient]; kwargs...)
Use this method to get the number of members in a chat. Returns Int on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target supergroup or channel (in the format@channelusername
)
Telegram.API.getChatMember
— FunctiongetChatMember([tg::TelegramClient]; kwargs...)
Use this method to get information about a member of a chat. Returns a ChatMember object on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target supergroup or channel (in the format@channelusername
)user_id
: (Integer) Unique identifier of the target user
Telegram.API.setChatStickerSet
— FunctionsetChatStickerSet([tg::TelegramClient]; kwargs...)
Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field cansetsticker_set optionally returned in getChat
requests to check if the bot can use this method. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
)sticker_set_name
: (String) Name of the sticker set to be set as the group sticker set
Telegram.API.deleteChatStickerSet
— FunctiondeleteChatStickerSet([tg::TelegramClient]; kwargs...)
Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Use the field cansetsticker_set optionally returned in getChat
requests to check if the bot can use this method. Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target supergroup (in the format@supergroupusername
)
Telegram.API.answerCallbackQuery
— FunctionanswerCallbackQuery([tg::TelegramClient]; kwargs...)
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.
Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create a game for your bot via @Botfather and accept the terms. Otherwise, you may use links like t.me/your_bot?start=XXXX
that open your bot with a parameter.
Required arguments
callback_query_id
: (String) Unique identifier for the query to be answered
Optional arguments
text
: (String) Text of the notification. If not specified, nothing will be shown to the user, 0-200 charactersshow_alert
: (Boolean) If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.url
: (String) 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 liket.me/your_bot?start=XXXX
that open your bot with a parameter.cache_time
: (Integer) 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.
Telegram.API.setMyCommands
— FunctionsetMyCommands([tg::TelegramClient]; kwargs...)
Use this method to change the list of the bot's commands. Returns True on success.
Required arguments
commands
: (Array of BotCommand) 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.
Telegram.API.getMyCommands
— FunctiongetMyCommands([tg::TelegramClient]; kwargs...)
Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of BotCommand on success.
Updating messages
Telegram.editMessageText
Telegram.editMessageCaption
Telegram.editMessageMedia
Telegram.editMessageReplyMarkup
Telegram.stopPoll
Telegram.deleteMessage
Telegram.API.editMessageText
— FunctioneditMessageText([tg::TelegramClient]; kwargs...)
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.
Required arguments
text
: (String) New text of the message, 1-4096 characters after entities parsing
Optional arguments
chat_id
: (Integer or String) Required if inlinemessageid is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
)message_id
: (Integer) Required if inlinemessageid is not specified. Identifier of the message to editinline_message_id
: (String) Required if chatid and messageid are not specified. Identifier of the inline messageparse_mode
: (String) Mode for parsing entities in the message text. See formatting options for more details.entities
: (Array of MessageEntity) List of special entities that appear in message text, which can be specified instead of parse_modedisable_web_page_preview
: (Boolean) Disables link previews for links in this messagereply_markup
: (InlineKeyboardMarkup) A JSON-serialized object for an inline keyboard.
Telegram.API.editMessageCaption
— FunctioneditMessageCaption([tg::TelegramClient]; kwargs...)
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.
Optional arguments
chat_id
: (Integer or String) Required if inlinemessageid is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
)message_id
: (Integer) Required if inlinemessageid is not specified. Identifier of the message to editinline_message_id
: (String) Required if chatid and messageid are not specified. Identifier of the inline messagecaption
: (String) New caption of the message, 0-1024 characters after entities parsingparse_mode
: (String) Mode for parsing entities in the message caption. See formatting options for more details.caption_entities
: (Array of MessageEntity) List of special entities that appear in the caption, which can be specified instead of parse_modereply_markup
: (InlineKeyboardMarkup) A JSON-serialized object for an inline keyboard.
Telegram.API.editMessageMedia
— FunctioneditMessageMedia([tg::TelegramClient]; kwargs...)
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 was sent by the bot, the edited Message is returned, otherwise True is returned.
Required arguments
media
: (InputMedia) A JSON-serialized object for a new media content of the message
Optional arguments
chat_id
: (Integer or String) Required if inlinemessageid is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
)message_id
: (Integer) Required if inlinemessageid is not specified. Identifier of the message to editinline_message_id
: (String) Required if chatid and messageid are not specified. Identifier of the inline messagereply_markup
: (InlineKeyboardMarkup) A JSON-serialized object for a new inline keyboard.
Telegram.API.editMessageReplyMarkup
— FunctioneditMessageReplyMarkup([tg::TelegramClient]; kwargs...)
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.
Optional arguments
chat_id
: (Integer or String) Required if inlinemessageid is not specified. Unique identifier for the target chat or username of the target channel (in the format@channelusername
)message_id
: (Integer) Required if inlinemessageid is not specified. Identifier of the message to editinline_message_id
: (String) Required if chatid and messageid are not specified. Identifier of the inline messagereply_markup
: (InlineKeyboardMarkup) A JSON-serialized object for an inline keyboard.
Telegram.API.stopPoll
— FunctionstopPoll([tg::TelegramClient]; kwargs...)
Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)message_id
: (Integer) Identifier of the original message with the poll
Optional arguments
reply_markup
: (InlineKeyboardMarkup) A JSON-serialized object for a new message inline keyboard.
Telegram.API.deleteMessage
— FunctiondeleteMessage([tg::TelegramClient]; kwargs...)
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.- 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 canpostmessages 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 candeletemessages permission in a supergroup or a channel, it can delete any message there.Returns True on success.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)message_id
: (Integer) Identifier of the message to delete
Stickers
Telegram.sendSticker
Telegram.getStickerSet
Telegram.uploadStickerFile
Telegram.createNewStickerSet
Telegram.addStickerToSet
Telegram.setStickerPositionInSet
Telegram.deleteStickerFromSet
Telegram.setStickerSetThumb
Telegram.API.sendSticker
— FunctionsendSticker([tg::TelegramClient]; kwargs...)
Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer or String) Unique identifier for the target chat or username of the target channel (in the format@channelusername
)sticker
: (InputFile or String) 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 »
Optional arguments
disable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply) 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.
Telegram.API.getStickerSet
— FunctiongetStickerSet([tg::TelegramClient]; kwargs...)
Use this method to get a sticker set. On success, a StickerSet object is returned.
Required arguments
name
: (String) Name of the sticker set
Telegram.API.uploadStickerFile
— FunctionuploadStickerFile([tg::TelegramClient]; kwargs...)
Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
Required arguments
user_id
: (Integer) User identifier of sticker file ownerpng_sticker
: (InputFile) PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. More info on Sending Files »
Telegram.API.createNewStickerSet
— FunctioncreateNewStickerSet([tg::TelegramClient]; kwargs...)
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. You must use exactly one of the fields pngsticker or tgssticker. Returns True on success.
Required arguments
user_id
: (Integer) User identifier of created sticker set ownername
: (String) Short name of sticker set, to be used int.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.title
: (String) Sticker set title, 1-64 charactersemojis
: (String) One or more emoji corresponding to the sticker
Optional arguments
png_sticker
: (InputFile or String) PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »tgs_sticker
: (InputFile) TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirementscontains_masks
: (Boolean) Pass True, if a set of mask stickers should be createdmask_position
: (MaskPosition) A JSON-serialized object for position where the mask should be placed on faces
Telegram.API.addStickerToSet
— FunctionaddStickerToSet([tg::TelegramClient]; kwargs...)
Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields pngsticker or tgssticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
Required arguments
user_id
: (Integer) User identifier of sticker set ownername
: (String) Sticker set nameemojis
: (String) One or more emoji corresponding to the sticker
Optional arguments
png_sticker
: (InputFile or String) PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files »tgs_sticker
: (InputFile) TGS animation with the sticker, uploaded using multipart/form-data. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirementsmask_position
: (MaskPosition) A JSON-serialized object for position where the mask should be placed on faces
Telegram.API.setStickerPositionInSet
— FunctionsetStickerPositionInSet([tg::TelegramClient]; kwargs...)
Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
Required arguments
sticker
: (String) File identifier of the stickerposition
: (Integer) New sticker position in the set, zero-based
Telegram.API.deleteStickerFromSet
— FunctiondeleteStickerFromSet([tg::TelegramClient]; kwargs...)
Use this method to delete a sticker from a set created by the bot. Returns True on success.
Required arguments
sticker
: (String) File identifier of the sticker
Telegram.API.setStickerSetThumb
— FunctionsetStickerSetThumb([tg::TelegramClient]; kwargs...)
Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.
Required arguments
name
: (String) Sticker set nameuser_id
: (Integer) User identifier of the sticker set owner
Optional arguments
thumb
: (InputFile or String) A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/animatedstickers#technical-requirements for animated sticker technical requirements. Pass a fileid as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files ». Animated sticker set thumbnail can't be uploaded via HTTP URL.
Inline mode
Telegram.API.answerInlineQuery
— FunctionanswerInlineQuery([tg::TelegramClient]; kwargs...)
Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed.
Required arguments
inline_query_id
: (String) Unique identifier for the answered queryresults
: (Array of InlineQueryResult) A JSON-serialized array of results for the inline query
Optional arguments
cache_time
: (Integer) The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.is_personal
: (Boolean) 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 querynext_offset
: (String) 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.switch_pm_text
: (String) 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 switchpmparameterswitch_pm_parameter
: (String) Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, onlyA-Z
,a-z
,0-9
,_
and-
are allowed.Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an oauth link. Once done, the bot can offer a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.
Payments
Telegram.API.sendInvoice
— FunctionsendInvoice([tg::TelegramClient]; kwargs...)
Use this method to send invoices. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer) Unique identifier for the target private chattitle
: (String) Product name, 1-32 charactersdescription
: (String) Product description, 1-255 characterspayload
: (String) Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.provider_token
: (String) Payments provider token, obtained via Botfatherstart_parameter
: (String) Unique deep-linking parameter that can be used to generate this invoice when used as a start parametercurrency
: (String) Three-letter ISO 4217 currency code, see more on currenciesprices
: (Array of LabeledPrice) Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
Optional arguments
provider_data
: (String) A 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.photo_url
: (String) 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.photo_size
: (Integer) Photo sizephoto_width
: (Integer) Photo widthphoto_height
: (Integer) Photo heightneed_name
: (Boolean) Pass True, if you require the user's full name to complete the orderneed_phone_number
: (Boolean) Pass True, if you require the user's phone number to complete the orderneed_email
: (Boolean) Pass True, if you require the user's email address to complete the orderneed_shipping_address
: (Boolean) Pass True, if you require the user's shipping address to complete the ordersend_phone_number_to_provider
: (Boolean) Pass True, if user's phone number should be sent to providersend_email_to_provider
: (Boolean) Pass True, if user's email address should be sent to provideris_flexible
: (Boolean) Pass True, if the final price depends on the shipping methoddisable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup) A JSON-serialized object for an inline keyboard. If empty, one 'Paytotal price
' button will be shown. If not empty, the first button must be a Pay button.
Telegram.API.answerShippingQuery
— FunctionanswerShippingQuery([tg::TelegramClient]; kwargs...)
If you sent an invoice requesting a shipping address and the parameter isflexible was specified, the Bot API will send an Update with a shippingquery field to the bot. Use this method to reply to shipping queries. On success, True is returned.
Required arguments
shipping_query_id
: (String) Unique identifier for the query to be answeredok
: (Boolean) Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible)
Optional arguments
shipping_options
: (Array of ShippingOption) Required if ok is True. A JSON-serialized array of available shipping options.error_message
: (String) 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.
Telegram.API.answerPreCheckoutQuery
— FunctionanswerPreCheckoutQuery([tg::TelegramClient]; kwargs...)
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 precheckoutquery. 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.
Required arguments
pre_checkout_query_id
: (String) Unique identifier for the query to be answeredok
: (Boolean) 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.
Optional arguments
error_message
: (String) 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.
Telegram Passport
Telegram.API.setPassportDataErrors
— FunctionsetPassportDataErrors([tg::TelegramClient]; kwargs...)
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.
Use 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.
Required arguments
user_id
: (Integer) User identifiererrors
: (Array of PassportElementError) A JSON-serialized array describing the errors
Games
Telegram.API.sendGame
— FunctionsendGame([tg::TelegramClient]; kwargs...)
Use this method to send a game. On success, the sent Message is returned.
Required arguments
chat_id
: (Integer) Unique identifier for the target chatgame_short_name
: (String) Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather.
Optional arguments
disable_notification
: (Boolean) Sends the message silently. Users will receive a notification with no sound.reply_to_message_id
: (Integer) If the message is a reply, ID of the original messageallow_sending_without_reply
: (Boolean) Pass True, if the message should be sent even if the specified replied-to message is not foundreply_markup
: (InlineKeyboardMarkup) 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.
Telegram.API.setGameScore
— FunctionsetGameScore([tg::TelegramClient]; kwargs...)
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.
Required arguments
user_id
: (Integer) User identifierscore
: (Integer) New score, must be non-negative
Optional arguments
force
: (Boolean) Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheatersdisable_edit_message
: (Boolean) Pass True, if the game message should not be automatically edited to include the current scoreboardchat_id
: (Integer) Required if inlinemessageid is not specified. Unique identifier for the target chatmessage_id
: (Integer) Required if inlinemessageid is not specified. Identifier of the sent messageinline_message_id
: (String) Required if chatid and messageid are not specified. Identifier of the inline message
Telegram.API.getGameHighScores
— FunctiongetGameHighScores([tg::TelegramClient]; kwargs...)
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. On success, returns an Array of GameHighScore objects.
This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.
Required arguments
user_id
: (Integer) Target user id
Optional arguments
chat_id
: (Integer) Required if inlinemessageid is not specified. Unique identifier for the target chatmessage_id
: (Integer) Required if inlinemessageid is not specified. Identifier of the sent messageinline_message_id
: (String) Required if chatid and messageid are not specified. Identifier of the inline message