Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. All previous updates will forgotten.

offset

Optional. Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100.

limit

Optional. Timeout in seconds for long polling. Defaults to 0 i.e. usual short polling. Should be positive short polling should be used for testing purposes only.

timeout

Optional. A JSON-serialized list of the update types you want your bot to receive. For example specify [“message” “edited_channel_post” “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (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.

allowed_updates

Optional. Pass True if the message should be sent even if the specified replied-to message is not found

Required. Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Optional. Sends the message silently. Users will receive a notification with no sound.

Optional. Disables link previews for links in this message

Optional. A JSON-serialized list of special entities that appear in message text which can be specified instead of parse_mode

Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

Optional. Mode for parsing entities in the message text. See formatting options for more details.

Optional. Protects the contents of the sent message from forwarding and saving

Optional. Additional interface options. A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user.

Optional. If the message is a reply ID of the original message

Required. Text of the message to be sent 1-4096 characters after entities parsing

Required. Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)

Required. Message identifier in the chat specified in from_chat_id

Optional. Protects the contents of the forwarded message from forwarding and saving

Copy various messages, excluding some types. No link provided

Optional. New caption for media 0-1024 characters after entities parsing. If not specified the original caption is kept

Optional. A JSON-serialized list of special entities that appear in the new caption which can be specified instead of parse_mode

Optional. Mode for parsing entities in the new caption. See formatting options for more details.

Optional. Photo caption (may also be used when resending photos by file_id) 0-1024 characters after entities parsing

Optional. A JSON-serialized list of special entities that appear in the caption which can be specified instead of parse_mode

Optional. Mode for parsing entities in the photo caption. See formatting options for more details.

Required. Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get a photo from the Internet or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files

Send video files, supported format MPEG4, file limit 50MB

Optional. Video caption (may also be used when resending videos by file_id) 0-1024 characters after entities parsing

Optional. Duration of sent video in seconds

Optional. Mode for parsing entities in the video caption. See formatting options for more details.

Optional. Pass True if the uploaded video is suitable for streaming

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file so you can pass “attach

Required. Video to send. Pass a file_id as String to send a video that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get a video from the Internet or upload a new video using multipart/form-data. More information on Sending Files »

Send video messages, format MPEG4, upto 1 minute

Optional.Pass True if the message should be sent even if the specified replied-to message is not found

Required.Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Optional.Sends the message silently.Users will receive a notification with no sound.

Optional.Duration of sent video in seconds

Optional.Video width and height i.e. diameter of the video message

Optional.Unique identifier for the target message thread (topic) of the forum; for forum supergroups only

Optional.Protects the contents of the sent message from forwarding and saving

Optional.Additional interface options.A JSON-serialized object for an inline keyboard custom reply keyboard instructions to remove reply keyboard or to force a reply from the user.

Optional.If the message is a reply ID of the original message

Optional.Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side.The thumbnail should be in JPEG format and less than 200 kB in size.A thumbnail's width and height should not exceed 320.Ignored if the file is not uploaded using multipart/form-data.Thumbnails can't be reused and can be only uploaded as a new file so you can pass “attach

Required.Video note to send.Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) or upload a new video using multipart/form-data. More information on Sending Files.Sending video notes by a URL is currently unsupported

Send general files, supported any type of file, file limit 50MB

Optional. Document caption (may also be used when resending documents by file_id) 0-1024 characters after entities parsing

Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data

Required. File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get a file from the Internet or upload a new one using multipart/form-data. More information on Sending Files »

Optional. Mode for parsing entities in the document caption. See formatting options for more details.

Send animation files, file limit 50 MB in size

Required. Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get an animation from the Internet or upload a new animation using multipart/form-data. More information on Sending Files »

Optional. Animation caption (may also be used when resending animation by file_id) 0-1024 characters after entities parsing

Optional. Duration of sent animation in seconds

Optional. Mode for parsing entities in the animation caption. See formatting options for more details.

Send Telegram voice messages: OGG, OPUS, 50MB limit

Optional. Voice message caption 0-1024 characters after entities parsing

Optional. Duration of the voice message in seconds

Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.

Required. Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get a file from the Internet or upload a new one using multipart/form-data. More information on Sending Files »

Send music files on Telegram: MP3, M4A, 50MB limit

Required. Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get an audio file from the Internet or upload a new one using multipart/form-data. More information on Sending Files

Optional. Audio caption 0-1024 characters after entities parsing

Optional. Duration of the audio in seconds

Optional. Mode for parsing entities in the audio caption. See formatting options for more details.

Send phone contacts seamlessly; receive the sent message

Optional.Additional data about the contact in the form of a vCard 0-2048 bytes

Send album: photos, videos, documents, audio files

chat_id

message_thread_id

Required.A JSON-serialized array describing messages to be sent must include 2-10 items

media

Optional.Sends messages silently. Users will receive a notification with no sound.

disable_notification

Optional.Protects the contents of the sent messages from forwarding and saving

protect_content

Optional.If the messages are a reply ID of the original message

reply_to_message_id

allow_sending_without_reply

Send animated emoji with random value on Telegram

Optional.____simple_html_dom__voku__html_wrapper____>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 “🎲”

Optional.Protects the contents of the sent message from forwarding

Delete messages with specific constraints: 48-hour limit, permissions-based

Required.Identifier of the message to delete

Delete messages, including service messages

Get file information, prepare for download: 20MB limit

Required.File identifier to get information about

file_id

Send stickers: .WEBP, .TGS, .WEBM; get returned Message

Required.Sticker to send.Pass a file_id as String to send a file that exists on the Telegram servers (recommended) pass an HTTP URL as a String for Telegram to get a.WEBP file from the Internet or upload a new one using multipart/form-data.More information on Sending Files »

Send static WEBP, animated TGS, or video WEBM stickers

Retrieve sticker set; return StickerSet object

name

Retrieve custom emoji sticker information with identifiers

Required.List of custom emoji identifiers.At most 200 custom emoji identifiers can be specified.

custom_emoji_ids

Get custom emoji sticker info by their identifiers

Upload PNG sticker for Telegram sticker sets

Required.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 information on Sending Files

Required.User identifier of sticker file owner

Upload sticker PNG for future use in sticker sets

Required.One or more emoji corresponding to the sticker

Optional.A JSON-serialized object for position where the mask should be placed on faces

Required.Short name of sticker set to be used in t.me/addstickers/ URLs (e.g.animals).Can contain only English letters digits and underscores.Must begin with a letter can't contain consecutive underscores and must end in "_by_<bot_username>".<bot_username> is case insensitive.1-64 characters.

Optional.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 information on Sending Files »

Optional.Type of stickers in the set pass “regular” or “mask”.Custom emoji sticker sets can't be created via the Bot API at the moment.By default a regular sticker set is created.

Optional.TGS animation with the sticker uploaded using multipart/form-data.See https

Required. Sticker set title 1-64 characters

Required.User identifier of created sticker set owner

Optional.WEBM video with the sticker uploaded using multipart/form-data. See https

Add new sticker to bot's set: animated/static, 50/120 limit

Optional.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 information on Sending Files

Required.User identifier of sticker set owner

Optional. WEBM video with the sticker uploaded using multipart/form-data. See https

Move bot-created sticker in set to position

Required.New sticker position in the set zero-based

Bot moves sticker to specific position in set

Set animated or video sticker set thumbnails easily.

Optional.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

Required.User identifier of the sticker set owner

Set sticker set thumbnail: animated for animations

Logout from cloud Bot API server before launching locally

Logout from Cloud Bot API before running locally

Close bot instance safely before server migration

Get a list of profile pictures for a user

Required.Unique identifier of the target user

user_id

Optional.Sequential number of the first photo to be returned.By default all photos are returned.

Optional.Limits the number of photos to be retrieved.Values between 1-100 are accepted.Defaults to 100.

Set webhook URL, receive updates, ensure security

Optional. A JSON-serialized list of the update types you want your bot to receive. For example specify [“message” “edited_channel_post” “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all update types except chat_member (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.

Optional. Upload your public key certificate so that the root certificate in use can be checked. See our self-signed guide for details.

Optional. Pass True to drop all pending updates

Optional. The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS

Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery 1-100. Defaults to 40. Use lower values to limit the load on your bot's server and higher values to increase your bot's throughput.

Optional. A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request 1-256 characters. Only characters A-Z a-z 0-9 _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you.

Required. HTTPS URL to send updates to. Use an empty string to remove webhook integration

Remove webhook integration, switch to getUpdates

Webhook URL, may be empty if webhook is not set up

True, if a custom certificate was provided for webhook certificate checks

has_custom_certificate

pending_update_count

ip_address

Unix time for the most recent error that happened when trying to deliver an update via webhook

last_error_date

Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook

last_error_message

Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters

last_synchronization_error_date

The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery

max_connections

A list of update types the bot is subscribed to. Defaults to all update types except chat_member

Telegram

Telegram API

Pre-configured, Predictable, Single Interface, Ready-to-use, Opinionated & Managed API Explorer & Server - LowCodeAPI

Pre-configured, Predictable, Single Interface, Ready-to-use, Opinionated & Managed API Explorer & Server. Bring your API credentials, configure and access your 3rd party APIs. Using LowCodeAPI securely manage all integrations in one place.

LowCodeAPI

Featured

OpenAI

Google Sheets

Google Docs

Notion

Gmail

gmail

Unsplash

UnsplashAPI

Cal API

Trello

Trello API

The Stripe API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.