Telegram

Interact with Telegram

Telegram is a secure, cloud-based messaging platform that enables fast and reliable communication across devices. With its powerful Bot API, Telegram provides a robust framework for automated messaging and integration.

With the Telegram integration in Sim, you can:

  • Send messages: Send text messages to Telegram chats, groups, or channels
  • Delete messages: Remove previously sent messages from a chat
  • Send photos: Share images with optional captions
  • Send videos: Share video files with optional captions
  • Send audio: Share audio files with optional captions
  • Send animations: Share GIF animations with optional captions
  • Send documents: Share files of any type with optional captions

In Sim, the Telegram integration enables your agents to send messages and rich media to Telegram chats as part of automated workflows. This is ideal for automated notifications, alerts, content distribution, and interactive bot experiences.

Learn how to create a webhook trigger in Sim that seamlessly initiates workflows from Telegram messages. This tutorial walks you through setting up a webhook, configuring it with Telegram's bot API, and triggering automated actions in real-time.

Learn how to use the Telegram Tool in Sim to seamlessly automate message delivery to any Telegram group. This tutorial walks you through integrating the tool into your workflow, configuring group messaging, and triggering automated updates in real-time.

Usage Instructions

Integrate Telegram into the workflow. Can send and delete messages. Can be used in trigger mode to trigger a workflow when a message is sent to a chat.

Tools

telegram_message

Send messages to Telegram channels or users through the Telegram Bot API. Enables direct communication and notifications with message tracking and chat confirmation.

Input

ParameterTypeRequiredDescription
botTokenstringYesYour Telegram Bot API Token
chatIdstringYesTelegram chat ID (numeric, can be negative for groups)
textstringYesMessage text to send

Output

ParameterTypeDescription
messagestringSuccess or error message
dataobjectTelegram message data
message_idnumberUnique Telegram message identifier
fromobjectChat information
idnumberChat ID
is_botbooleanWhether the chat is a bot or not
first_namestringChat username (if available)
usernamestringChat title (for groups and channels)
chatobjectInformation about the bot that sent the message
idnumberBot user ID
first_namestringBot first name
usernamestringBot username
typestringchat type private or channel
datenumberUnix timestamp when message was sent
textstringText content of the sent message

telegram_delete_message

Delete messages in Telegram channels or chats through the Telegram Bot API. Requires the message ID of the message to delete.

Input

ParameterTypeRequiredDescription
botTokenstringYesYour Telegram Bot API Token
chatIdstringYesTelegram chat ID (numeric, can be negative for groups)
messageIdstringYesTelegram message ID (numeric identifier of the message to delete)

Output

ParameterTypeDescription
messagestringSuccess or error message
dataobjectDelete operation result
okbooleanAPI response success status
deletedbooleanWhether the message was successfully deleted

telegram_send_photo

Send photos to Telegram channels or users through the Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesYour Telegram Bot API Token
chatIdstringYesTelegram chat ID (numeric, can be negative for groups)
photostringYesPhoto to send. Pass a file_id or HTTP URL
captionstringNoPhoto caption (optional)

Output

ParameterTypeDescription
messagestringSuccess or error message
dataobjectTelegram message data including optional photo(s)
message_idnumberUnique Telegram message identifier
fromobjectChat information
idnumberChat ID
is_botbooleanWhether the chat is a bot or not
first_namestringChat username (if available)
usernamestringChat title (for groups and channels)
chatobjectInformation about the bot that sent the message
idnumberBot user ID
first_namestringBot first name
usernamestringBot username
typestringChat type (private, group, supergroup, channel)
datenumberUnix timestamp when message was sent
textstringText content of the sent message (if applicable)
photoarrayList of photos included in the message
file_idstringUnique file ID of the photo
file_unique_idstringUnique identifier for this file across different bots
file_sizenumberSize of the photo file in bytes
widthnumberPhoto width in pixels
heightnumberPhoto height in pixels

telegram_send_video

Send videos to Telegram channels or users through the Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesYour Telegram Bot API Token
chatIdstringYesTelegram chat ID (numeric, can be negative for groups)
videostringYesVideo to send. Pass a file_id or HTTP URL
captionstringNoVideo caption (optional)

Output

ParameterTypeDescription
messagestringSuccess or error message
dataobjectTelegram message data including optional media
message_idnumberUnique Telegram message identifier
fromobjectInformation about the sender
idnumberSender ID
is_botbooleanWhether the chat is a bot or not
first_namestringSender's first name (if available)
usernamestringSender's username (if available)
chatobjectInformation about the chat where message was sent
idnumberChat ID
first_namestringChat first name (if private chat)
usernamestringChat username (for private or channels)
typestringType of chat (private, group, supergroup, or channel)
datenumberUnix timestamp when the message was sent
textstringText content of the sent message (if applicable)
formatobjectMedia format information (for videos, GIFs, etc.)
file_namestringMedia file name
mime_typestringMedia MIME type
durationnumberDuration of media in seconds
widthnumberMedia width in pixels
heightnumberMedia height in pixels
thumbnailobjectThumbnail image details
file_idstringThumbnail file ID
file_unique_idstringUnique thumbnail file identifier
file_sizenumberThumbnail file size in bytes
widthnumberThumbnail width in pixels
heightnumberThumbnail height in pixels
thumbobjectSecondary thumbnail details (duplicate of thumbnail)
file_idstringThumbnail file ID
file_unique_idstringUnique thumbnail file identifier
file_sizenumberThumbnail file size in bytes
widthnumberThumbnail width in pixels
heightnumberThumbnail height in pixels
file_idstringMedia file ID
file_unique_idstringUnique media file identifier
file_sizenumberSize of media file in bytes
documentobjectDocument file details if the message contains a document
file_namestringDocument file name
mime_typestringDocument MIME type
thumbnailobjectDocument thumbnail information
file_idstringThumbnail file ID
file_unique_idstringUnique thumbnail file identifier
file_sizenumberThumbnail file size in bytes
widthnumberThumbnail width in pixels
heightnumberThumbnail height in pixels
thumbobjectDuplicate thumbnail info (used for compatibility)
file_idstringThumbnail file ID
file_unique_idstringUnique thumbnail file identifier
file_sizenumberThumbnail file size in bytes
widthnumberThumbnail width in pixels
heightnumberThumbnail height in pixels
file_idstringDocument file ID
file_unique_idstringUnique document file identifier
file_sizenumberSize of document file in bytes

telegram_send_audio

Send audio files to Telegram channels or users through the Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesYour Telegram Bot API Token
chatIdstringYesTelegram chat ID (numeric, can be negative for groups)
audiostringYesAudio file to send. Pass a file_id or HTTP URL
captionstringNoAudio caption (optional)

Output

ParameterTypeDescription
messagestringSuccess or error message
dataobjectTelegram message data including voice/audio information
message_idnumberUnique Telegram message identifier
fromobjectInformation about the sender
idnumberSender ID
is_botbooleanWhether the chat is a bot or not
first_namestringSender's first name (if available)
usernamestringSender's username (if available)
chatobjectInformation about the chat where the message was sent
idnumberChat ID
first_namestringChat first name (if private chat)
usernamestringChat username (for private or channels)
typestringType of chat (private, group, supergroup, or channel)
datenumberUnix timestamp when the message was sent
textstringText content of the sent message (if applicable)
audioobjectAudio file details
durationnumberDuration of the audio in seconds
performerstringPerformer of the audio
titlestringTitle of the audio
file_namestringOriginal filename of the audio
mime_typestringMIME type of the audio file
file_idstringUnique file identifier for this audio
file_unique_idstringUnique identifier across different bots for this file
file_sizenumberSize of the audio file in bytes

telegram_send_animation

Send animations (GIFs) to Telegram channels or users through the Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesYour Telegram Bot API Token
chatIdstringYesTelegram chat ID (numeric, can be negative for groups)
animationstringYesAnimation to send. Pass a file_id or HTTP URL
captionstringNoAnimation caption (optional)

Output

ParameterTypeDescription
messagestringSuccess or error message
dataobjectTelegram message data including optional media
message_idnumberUnique Telegram message identifier
fromobjectInformation about the sender
idnumberSender ID
is_botbooleanWhether the chat is a bot or not
first_namestringSender's first name (if available)
usernamestringSender's username (if available)
chatobjectInformation about the chat where message was sent
idnumberChat ID
first_namestringChat first name (if private chat)
usernamestringChat username (for private or channels)
typestringType of chat (private, group, supergroup, or channel)
datenumberUnix timestamp when the message was sent
textstringText content of the sent message (if applicable)
formatobjectMedia format information (for videos, GIFs, etc.)
file_namestringMedia file name
mime_typestringMedia MIME type
durationnumberDuration of media in seconds
widthnumberMedia width in pixels
heightnumberMedia height in pixels
thumbnailobjectThumbnail image details
file_idstringThumbnail file ID
file_unique_idstringUnique thumbnail file identifier
file_sizenumberThumbnail file size in bytes
widthnumberThumbnail width in pixels
heightnumberThumbnail height in pixels
thumbobjectSecondary thumbnail details (duplicate of thumbnail)
file_idstringThumbnail file ID
file_unique_idstringUnique thumbnail file identifier
file_sizenumberThumbnail file size in bytes
widthnumberThumbnail width in pixels
heightnumberThumbnail height in pixels
file_idstringMedia file ID
file_unique_idstringUnique media file identifier
file_sizenumberSize of media file in bytes
documentobjectDocument file details if the message contains a document
file_namestringDocument file name
mime_typestringDocument MIME type
thumbnailobjectDocument thumbnail information
file_idstringThumbnail file ID
file_unique_idstringUnique thumbnail file identifier
file_sizenumberThumbnail file size in bytes
widthnumberThumbnail width in pixels
heightnumberThumbnail height in pixels
thumbobjectDuplicate thumbnail info (used for compatibility)
file_idstringThumbnail file ID
file_unique_idstringUnique thumbnail file identifier
file_sizenumberThumbnail file size in bytes
widthnumberThumbnail width in pixels
heightnumberThumbnail height in pixels
file_idstringDocument file ID
file_unique_idstringUnique document file identifier
file_sizenumberSize of document file in bytes

telegram_send_document

Send documents (PDF, ZIP, DOC, etc.) to Telegram channels or users through the Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesYour Telegram Bot API Token
chatIdstringYesTelegram chat ID (numeric, can be negative for groups)
filesfile[]NoDocument file to send (PDF, ZIP, DOC, etc.). Max size: 50MB
captionstringNoDocument caption (optional)

Output

ParameterTypeDescription
messagestringSuccess or error message
filesfile[]Files attached to the message
dataobjectTelegram message data including document
message_idnumberUnique Telegram message identifier
fromobjectInformation about the sender
idnumberSender ID
is_botbooleanWhether the chat is a bot or not
first_namestringSender's first name (if available)
usernamestringSender's username (if available)
chatobjectInformation about the chat where message was sent
idnumberChat ID
first_namestringChat first name (if private chat)
usernamestringChat username (for private or channels)
typestringType of chat (private, group, supergroup, or channel)
datenumberUnix timestamp when the message was sent
documentobjectDocument file details
file_namestringDocument file name
mime_typestringDocument MIME type
file_idstringDocument file ID
file_unique_idstringUnique document file identifier
file_sizenumberSize of document file in bytes

On this page

Start building today
Trusted by over 70,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started