AACFlow

Telegram

Interact with Telegram

Usage Instructions

Integrate Telegram into the workflow. Send messages, media, invoices, and manage Mini-Apps. Can be used in trigger mode to trigger a workflow on incoming bot updates including payments.

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
botTokenstringYesNo description
chatIdstringYesNo description
textstringYesNo description

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_send_photo

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
photostringYesNo description
captionstringNoNo description

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

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
videostringYesNo description
captionstringNoNo description

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

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
audiostringYesNo description
captionstringNoNo description

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

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
animationstringYesNo description
captionstringNoNo description

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
botTokenstringYesNo description
chatIdstringYesNo description
filesfile[]NoNo description
captionstringNoNo description

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

telegram_send_voice

Send voice messages to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
voicestringYesNo description
captionstringNoNo description
durationnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent message object

telegram_send_video_note

Send video notes (rounded video messages) to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
videoNotestringYesNo description
durationnumberNoNo description
lengthnumberNoNo description
thumbnailstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent message object

telegram_send_media_group

Send a group of media items (photos, videos, etc.) to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
mediastringYesJSON array of InputMedia objects

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent messages array

telegram_send_sticker

Send stickers to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
stickerstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent message object

telegram_send_location

Send geographic locations to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
latitudenumberYesNo description
longitudenumberYesNo description
livePeriodnumberNoNo description
headingnumberNoNo description
proximityAlertRadiusnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent message object

telegram_send_venue

Send venue information to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
latitudenumberYesNo description
longitudenumberYesNo description
titlestringYesNo description
addressstringYesNo description
foursquareIdstringNoNo description
googlePlaceIdstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent message object

telegram_send_contact

Send phone contacts to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
phoneNumberstringYesNo description
firstNamestringYesNo description
lastNamestringNoNo description
vcardstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent message object

telegram_send_poll

Send polls to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
questionstringYesNo description
optionsstringYesJSON array of answer options
isAnonymousbooleanNoNo description
typestringNoNo description
allowsMultipleAnswersbooleanNoNo description
correctOptionIdnumberNoNo description
explanationstringNoNo description
openPeriodnumberNoNo description
closeDatenumberNoNo description
isClosedbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent poll message object

telegram_send_dice

Send dice (or other animated emoji) to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
emojistringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent dice message object

telegram_send_chat_action

Send chat actions (typing, uploading, etc.) to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
actionstringYestyping, upload_photo, record_video, upload_video, record_voice, upload_voice, upload_document, choose_sticker, find_location, record_video_note, upload_video_note

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonChat action result

telegram_send_game

Send games to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
gameShortNamestringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent game message object

telegram_send_paid_media

Send paid media (photos, videos, etc.) to Telegram channels through the Bot API for Telegram Stars.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
starCountnumberYesNo description
mediastringYesJSON array of InputPaidMedia
payloadstringNoNo description
captionstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent paid media message object

telegram_send_live_photo

Send live photos (video + still image) to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
livePhotostringYesNo description
photostringYesNo description
captionstringNoNo description
hasSpoilerbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent live photo message object

telegram_send_gift

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberNoNo description
chatIdstringNoNo description
giftIdstringYesNo description
textstringNoNo description
textParseModestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_forward_message

Forward messages between Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
fromChatIdstringYesNo description
messageIdstringYesNo description
disableNotificationbooleanNoNo description
protectContentbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent message object

telegram_copy_message

Copy messages between Telegram chats through the Bot API without the original formatting.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
fromChatIdstringYesNo description
messageIdstringYesNo description
captionstringNoNo description
parseModestringNoNo description
disableNotificationbooleanNoNo description
protectContentbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonMessageId object

telegram_send_message_draft

Send a message draft (previously saved) to Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
draftIdnumberYesNo description
textstringNoNo description
parseModestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSent message object

telegram_set_message_reaction

Set reactions on messages in Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
reactionstringNoJSON array of ReactionType
isBigbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonReaction set result

telegram_edit_message_text

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
textstringYesNo description
parseModestringNoNo description
linkPreviewOptionsjsonNoNo description
replyMarkupjsonNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonEdited message object or True

telegram_edit_message_caption

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
captionstringNoNo description
replyMarkupjsonNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonEdited message object or True

telegram_edit_message_media

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
mediastringYesJSON object of InputMedia
replyMarkupjsonNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonEdited message object or True

telegram_edit_message_reply_markup

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
replyMarkupjsonNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonEdited message object or True

telegram_stop_poll

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
replyMarkupjsonNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonStopped poll object

telegram_edit_message_live_location

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
latitudenumberYesNo description
longitudenumberYesNo description
horizontalAccuracynumberNoNo description
headingnumberNoNo description
proximityAlertRadiusnumberNoNo description
replyMarkupjsonNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonEdited message object or True

telegram_stop_message_live_location

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
replyMarkupjsonNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonEdited message object or True

telegram_answer_callback_query

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
callbackQueryIdstringYesNo description
textstringNoNo description
showAlertbooleanNoNo description
urlstringNoNo description
cacheTimenumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_answer_inline_query

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
inlineQueryIdstringYesNo description
resultsstringYesJSON array of InlineQueryResult objects
cacheTimenumberNoNo description
isPersonalbooleanNoNo description
nextOffsetstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_answer_guest_query

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
guestQueryIdstringYesNo description
resultstringYesJSON object of InlineQueryResult

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_chat

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_chat_administrators

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_chat_member

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_chat_member_count

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_user_profile_photos

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
offsetnumberNoNo description
limitnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_file

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
fileIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_me

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_ban_chat_member

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberYesNo description
untilDatenumberNoNo description
revokeMessagesbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_unban_chat_member

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberYesNo description
onlyIfBannedbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_restrict_chat_member

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberYesNo description
permissionsstringYesNo description
untilDatenumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_promote_chat_member

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberYesNo description
isAnonymousbooleanNoNo description
canManageChatbooleanNoNo description
canDeleteMessagesbooleanNoNo description
canManageVideoChatsbooleanNoNo description
canRestrictMembersbooleanNoNo description
canPromoteMembersbooleanNoNo description
canChangeInfobooleanNoNo description
canInviteUsersbooleanNoNo description
canPostMessagesbooleanNoNo description
canEditMessagesbooleanNoNo description
canPinMessagesbooleanNoNo description
canManageTopicsbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_chat_administrator_custom_title

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberYesNo description
customTitlestringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_ban_chat_sender_chat

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
senderChatIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_unban_chat_sender_chat

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
senderChatIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_leave_chat

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_pin_chat_message

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
disableNotificationbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_unpin_chat_message

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_unpin_all_chat_messages

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_chat_title

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
titlestringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_chat_description

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
descriptionstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_chat_permissions

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
permissionsstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
namestringNoNo description
expireDatenumberNoNo description
memberLimitnumberNoNo description
createsJoinRequestbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
inviteLinkstringYesNo description
namestringNoNo description
expireDatenumberNoNo description
memberLimitnumberNoNo description
createsJoinRequestbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
inviteLinkstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_approve_chat_join_request

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_decline_chat_join_request

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_create_forum_topic

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
namestringYesNo description
iconColornumberNoNo description
iconCustomEmojiIdstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_edit_forum_topic

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageThreadIdnumberYesNo description
namestringNoNo description
iconCustomEmojiIdstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_close_forum_topic

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageThreadIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_reopen_forum_topic

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageThreadIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_delete_forum_topic

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageThreadIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_unpin_all_forum_topic_messages

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageThreadIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_forum_topic_icon_stickers

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_edit_general_forum_topic

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
namestringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_close_general_forum_topic

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_reopen_general_forum_topic

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_hide_general_forum_topic

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_unhide_general_forum_topic

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_send_invoice

Send a payment invoice to a Telegram chat. Supports both real payments (requires provider_token) and Telegram Stars (XTR currency, no provider_token needed).

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
titlestringYesNo description
descriptionstringYesNo description
payloadstringYesNo description
providerTokenstringNoNo description
currencystringYesNo description
pricesstringYesNo description

Output

ParameterTypeDescription
messagestringSuccess or error message
dataobjectTelegram message object for the sent invoice
message_idnumberInvoice message ID
datenumberUnix timestamp of the message

Create a payment invoice link that can be shared in chats or embedded in Mini-App deep-links. Supports both real payments and Telegram Stars (XTR).

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
titlestringYesNo description
descriptionstringYesNo description
payloadstringYesNo description
providerTokenstringNoNo description
currencystringYesNo description
pricesstringYesNo description

Output

ParameterTypeDescription
messagestringSuccess or error message
invoiceLinkstringGenerated invoice payment link URL

telegram_answer_pre_checkout_query

Respond to a pre-checkout query triggered by the user confirming payment. Must be called within 10 seconds of receiving the pre_checkout_query update. Approve or decline with an error message.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
preCheckoutQueryIdstringYesNo description
okbooleanYesNo description
errorMessagestringNoNo description

Output

ParameterTypeDescription
messagestringSuccess or error message
resultbooleanTrue if the answer was accepted by Telegram

telegram_answer_shipping_query

Reply to a shipping query when the invoice has the flexible flag set and the user has provided a delivery address. Provide shipping options or an error message.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
shippingQueryIdstringYesNo description
okbooleanYesNo description
shippingOptionsstringNoNo description
errorMessagestringNoNo description

Output

ParameterTypeDescription
messagestringSuccess or error message
resultbooleanTrue if the answer was accepted by Telegram

telegram_refund_star_payment

Refund a successful Telegram Stars (XTR) payment to the user. Requires the user ID and the Telegram payment charge ID from the successful_payment update.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdstringYesNo description
telegramPaymentChargeIdstringYesNo description

Output

ParameterTypeDescription
messagestringSuccess or error message
resultbooleanTrue if the refund was processed successfully

telegram_get_star_transactions

Retrieve the history of Telegram Stars (XTR) transactions for the bot. Returns a paginated list of StarTransaction objects ordered by date descending.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
offsetnumberNoNo description
limitnumberNoNo description

Output

ParameterTypeDescription
messagestringSuccess or error message
transactionsobjectStarTransactions object containing the list of transactions
transactionsarrayArray of StarTransaction objects

telegram_get_my_star_balance

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_edit_user_star_subscription

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
telegramPaymentChargeIdstringYesNo description
isCanceledbooleanYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_gift_premium_subscription

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
monthCountnumberYesNo description
starCountnumberYesNo description
textstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_chat_menu_button

Set the bot

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringNoNo description
buttonTypestringYesNo description
buttonTextstringNoNo description
webAppUrlstringNoNo description

Output

ParameterTypeDescription
messagestringSuccess or error message
resultbooleanTrue if the menu button was updated

telegram_get_chat_menu_button

Retrieve the current menu button for a private chat or the bot

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringNoNo description

Output

ParameterTypeDescription
messagestringSuccess or error message
menuButtonobjectMenuButton object describing the current menu button
typestringButton type: default, commands, or web_app
textstringButton text (only for web_app type)

telegram_answer_web_app_query

Send an inline result from a Telegram Mini-App (Web App) back to the chat. Use this to deliver data from your Mini-App query to the user that initiated it.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
webAppQueryIdstringYesNo description
resultstringYesNo description

Output

ParameterTypeDescription
messagestringSuccess or error message
sentWebAppMessageobjectSentWebAppMessage object with the inline_message_id
inline_message_idstringIdentifier of the sent inline message

telegram_set_my_commands

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
commandsstringYesNo description
scopestringNoNo description
languageCodestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_my_commands

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
scopestringNoNo description
languageCodestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_delete_my_commands

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
scopestringNoNo description
languageCodestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_my_name

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
namestringNoNo description
languageCodestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_my_name

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
languageCodestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_my_description

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
descriptionstringNoNo description
languageCodestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_my_description

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
languageCodestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_my_short_description

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
shortDescriptionstringNoNo description
languageCodestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_my_short_description

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
languageCodestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_my_default_administrator_rights

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
rightsstringNoJSON object of ChatAdministratorRights
forChannelsbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_my_default_administrator_rights

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
forChannelsbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_available_gifts

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_game_score

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
okbooleanAPI response success status
resultjsonComplete message result object from Telegram API
messagestringSuccess or error message
datajsonResponse data
filesfile[]Files attached to the message
messageIdnumberSent message ID
chatIdnumberChat ID where message was sent
chatTypestringType of chat (private, group, supergroup, channel)
usernamestringChat username (if available)
messageDatenumberUnix timestamp of sent message
messageTextstringText content of sent message
deletedbooleanWhether the message was successfully deleted
invoiceLinkstringGenerated invoice link URL
transactionsjsonStarTransactions result object
menuButtonjsonCurrent MenuButton object
sentWebAppMessagejsonSentWebAppMessage with inline_message_id
update_idnumberUnique identifier for the update
message_idnumberUnique message identifier from webhook
from_idnumberUser ID who sent the message
from_usernamestringUsername of the sender
from_first_namestringFirst name of the sender
from_last_namestringLast name of the sender
chat_idnumberUnique identifier for the chat
chat_typestringType of chat (private, group, supergroup, channel)
chat_titlestringTitle of the chat (for groups and channels)
textstringMessage text content from webhook
datenumberDate the message was sent (Unix timestamp)
entitiesjsonSpecial entities in the message (mentions, hashtags, etc.)

telegram_get_game_high_scores

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
chatIdstringNoNo description
messageIdnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonArray of GameHighScore objects

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
botTokenstringYesNo description
chatIdstringYesNo description
messageIdstringYesNo description

Output

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

telegram_get_sticker_set

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
namestringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_custom_emoji_stickers

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
customEmojiIdsstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_upload_sticker_file

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
stickerstringYesNo description
stickerFormatstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_create_new_sticker_set

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
namestringYesNo description
titlestringYesNo description
stickersstringYesNo description
stickerTypestringNoNo description
needsRepaintingbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_add_sticker_to_set

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
namestringYesNo description
stickerstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_delete_sticker_from_set

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
stickerstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_sticker_position_in_set

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
stickerstringYesNo description
positionnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_sticker_set_thumbnail

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
namestringYesNo description
userIdnumberYesNo description
thumbnailstringNoNo description
formatstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_delete_sticker_set

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
namestringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_send_checklist

Send a checklist message in a Telegram Bot API business connection.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
chatIdstringYesNo description
checkliststringYesJSON object of InputChecklist
disableNotificationbooleanNoNo description
protectContentbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_forward_messages

Forward multiple messages between Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
fromChatIdstringYesNo description
messageIdsstringYesJSON array of message IDs
disableNotificationbooleanNoNo description
protectContentbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonForwarded messages result

telegram_copy_messages

Copy multiple messages between Telegram chats through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
fromChatIdstringYesNo description
messageIdsstringYesJSON array of message IDs
disableNotificationbooleanNoNo description
protectContentbooleanNoNo description
removeCaptionbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonCopied messages result

telegram_delete_messages

Delete multiple messages in a Telegram chat through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdsstringYesJSON array of message IDs

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonDelete messages result

telegram_set_chat_photo

Set a new profile photo for a Telegram chat through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
photostringYesURL or file_id of new photo

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSet chat photo result

telegram_delete_chat_photo

Delete the profile photo of a Telegram chat through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonDelete chat photo result

telegram_set_chat_sticker_set

Set the sticker set for a Telegram supergroup chat through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
stickerSetNamestringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSet chat sticker set result

telegram_delete_chat_sticker_set

Delete the sticker set of a Telegram supergroup chat through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonDelete chat sticker set result

telegram_set_chat_member_tag

Set a tag on a member in a Telegram chat through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberYesNo description
tagstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSet chat member tag result

Create a subscription invite link for a Telegram chat through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
subscriptionPeriodnumberYesNo description
subscriptionPricenumberYesNo description
namestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonCreated subscription invite link object

Edit a subscription invite link for a Telegram chat through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
inviteLinkstringYesNo description
namestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonEdited subscription invite link object

telegram_unpin_all_general_forum_topic_messages

Unpin all messages in the general forum topic of a Telegram chat through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonUnpin all general forum topic messages result

telegram_set_my_profile_photo

Set the profile photo for the bot through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
photostringYesJSON object of InputProfilePhoto

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSet my profile photo result

telegram_remove_my_profile_photo

Remove the profile photo of the bot through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonRemove my profile photo result

telegram_log_out

Log out from the Telegram Bot API server.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_close

Close the bot instance on the Telegram Bot API server.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_user_chat_boosts

Get the list of boosts a user has given to a Telegram chat through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonUser chat boosts list

telegram_get_business_connection

Get information about a Telegram business connection through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonBusiness connection object

telegram_get_user_personal_chat_messages

Get messages from user personal chats through the Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
limitnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonUser personal chat messages

telegram_get_user_profile_audios

Get profile audios of a Telegram user through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
offsetnumberNoNo description
limitnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonUser profile audios

telegram_set_user_emoji_status

Set the emoji status for a Telegram user through the Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
emojiStatusCustomEmojiIdstringNoNo description
emojiStatusExpirationDatenumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonSet user emoji status result

telegram_verify_user

Verify a user in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
customDescriptionstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_verify_chat

Verify a chat in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
customDescriptionstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_remove_user_verification

Remove verification from a user in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_remove_chat_verification

Remove verification from a chat in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_read_business_message

Read a business message in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
chatIdnumberYesNo description
messageIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_delete_business_messages

Delete multiple business messages in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
messageIdsstringYesJSON array of message IDs

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_business_account_name

Set the name of a business account in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
firstNamestringYesNo description
lastNamestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_business_account_username

Set the username of a business account in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
usernamestringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_business_account_bio

Set the bio of a business account in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
biostringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_business_account_profile_photo

Set the profile photo of a business account in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
photostringYesJSON object of InputProfilePhoto
isPublicbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_remove_business_account_profile_photo

Remove the profile photo of a business account in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
isPublicbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_business_account_gift_settings

Set the gift settings of a business account in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
showGiftButtonbooleanYesNo description
acceptedGiftTypesstringYesJSON object of AcceptedGiftTypes

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_business_account_star_balance

Get the star balance of a business account in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonBusiness account star balance

telegram_transfer_business_account_stars

Transfer stars from a business account in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
starCountnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_business_account_gifts

Get gifts of a business account in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
excludeUnsavedbooleanNoNo description
excludeSavedbooleanNoNo description
excludeUnlimitedbooleanNoNo description
excludeLimitedUpgradablebooleanNoNo description
excludeLimitedNonUpgradablebooleanNoNo description
excludeUniquebooleanNoNo description
excludeFromBlockchainbooleanNoNo description
sortByPricebooleanNoNo description
offsetstringNoNo description
limitnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_user_gifts

Get gifts owned by a user in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
excludeUnlimitedbooleanNoNo description
excludeLimitedUpgradablebooleanNoNo description
excludeLimitedNonUpgradablebooleanNoNo description
excludeUniquebooleanNoNo description
sortByPricebooleanNoNo description
offsetstringNoNo description
limitnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_chat_gifts

Get gifts owned by a chat in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
excludeUnsavedbooleanNoNo description
excludeSavedbooleanNoNo description
excludeUnlimitedbooleanNoNo description
excludeLimitedUpgradablebooleanNoNo description
excludeLimitedNonUpgradablebooleanNoNo description
excludeUniquebooleanNoNo description
sortByPricebooleanNoNo description
offsetstringNoNo description
limitnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_convert_gift_to_stars

Convert a gift to Telegram Stars in a business connection.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
ownedGiftIdstringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_upgrade_gift

Upgrade a gift in a Telegram Bot API business connection.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
ownedGiftIdstringYesNo description
keepOriginalDetailsbooleanNoNo description
starCountnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_transfer_gift

Transfer a gift to a new owner in a Telegram Bot API business connection.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
ownedGiftIdstringYesNo description
newOwnerChatIdnumberYesNo description
starCountnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_sticker_emoji_list

Set the emoji list for a sticker in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
stickerstringYesNo description
emojiListstringYesJSON array of emoji

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_sticker_keywords

Set the keywords for a sticker in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
stickerstringYesNo description
keywordsstringNoJSON array of keywords

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_sticker_mask_position

Set the mask position for a sticker in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
stickerstringYesNo description
maskPositionstringNoJSON object of MaskPosition

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_sticker_set_title

Set the title of a sticker set in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
namestringYesNo description
titlestringYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_custom_emoji_sticker_set_thumbnail

Set the thumbnail for a custom emoji sticker set in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
namestringYesNo description
customEmojiIdstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_replace_sticker_in_set

Replace a sticker in a sticker set in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
namestringYesNo description
oldStickerstringYesNo description
stickerstringYesJSON object of InputSticker

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_approve_suggested_post

Approve a suggested post in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdnumberYesNo description
messageIdnumberYesNo description
sendDatenumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_decline_suggested_post

Decline a suggested post in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdnumberYesNo description
messageIdnumberYesNo description
commentstringNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_delete_message_reaction

Delete a reaction from a message in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
userIdnumberNoNo description
actorChatIdnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_delete_all_message_reactions

Delete all reactions from a message in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
chatIdstringYesNo description
userIdnumberNoNo description
actorChatIdnumberNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_managed_bot_token

Get the token of a managed bot in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonManaged bot token

telegram_replace_managed_bot_token

Replace the token of a managed bot in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_get_managed_bot_access_settings

Get access settings of a managed bot for a user in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_set_managed_bot_access_settings

Set access settings of a managed bot for a user in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
isAccessRestrictedbooleanYesNo description
addedUserIdsstringNoJSON array of user IDs

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_save_prepared_inline_message

Save a prepared inline message in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
resultstringYesJSON object of InlineQueryResult
allowUserChatsbooleanNoNo description
allowBotChatsbooleanNoNo description
allowGroupChatsbooleanNoNo description
allowChannelChatsbooleanNoNo description

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_save_prepared_keyboard_button

Save a prepared keyboard button for a user in Telegram Bot API.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
userIdnumberYesNo description
buttonstringYesJSON object of KeyboardButton

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

telegram_edit_message_checklist

Edit the checklist of a message in a Telegram Bot API business connection.

Input

ParameterTypeRequiredDescription
botTokenstringYesNo description
businessConnectionIdstringYesNo description
chatIdstringYesNo description
messageIdnumberYesNo description
checkliststringYesJSON object of InputChecklist

Output

ParameterTypeDescription
okbooleanSuccess status
resultjsonAPI response result

On this page

Usage Instructions
Tools
telegram_message
Input
Output
telegram_send_photo
Input
Output
telegram_send_video
Input
Output
telegram_send_audio
Input
Output
telegram_send_animation
Input
Output
telegram_send_document
Input
Output
telegram_send_voice
Input
Output
telegram_send_video_note
Input
Output
telegram_send_media_group
Input
Output
telegram_send_sticker
Input
Output
telegram_send_location
Input
Output
telegram_send_venue
Input
Output
telegram_send_contact
Input
Output
telegram_send_poll
Input
Output
telegram_send_dice
Input
Output
telegram_send_chat_action
Input
Output
telegram_send_game
Input
Output
telegram_send_paid_media
Input
Output
telegram_send_live_photo
Input
Output
telegram_send_gift
Input
Output
telegram_forward_message
Input
Output
telegram_copy_message
Input
Output
telegram_send_message_draft
Input
Output
telegram_set_message_reaction
Input
Output
telegram_edit_message_text
Input
Output
telegram_edit_message_caption
Input
Output
telegram_edit_message_media
Input
Output
telegram_edit_message_reply_markup
Input
Output
telegram_stop_poll
Input
Output
telegram_edit_message_live_location
Input
Output
telegram_stop_message_live_location
Input
Output
telegram_answer_callback_query
Input
Output
telegram_answer_inline_query
Input
Output
telegram_answer_guest_query
Input
Output
telegram_get_chat
Input
Output
telegram_get_chat_administrators
Input
Output
telegram_get_chat_member
Input
Output
telegram_get_chat_member_count
Input
Output
telegram_get_user_profile_photos
Input
Output
telegram_get_file
Input
Output
telegram_get_me
Input
Output
telegram_ban_chat_member
Input
Output
telegram_unban_chat_member
Input
Output
telegram_restrict_chat_member
Input
Output
telegram_promote_chat_member
Input
Output
telegram_set_chat_administrator_custom_title
Input
Output
telegram_ban_chat_sender_chat
Input
Output
telegram_unban_chat_sender_chat
Input
Output
telegram_leave_chat
Input
Output
telegram_pin_chat_message
Input
Output
telegram_unpin_chat_message
Input
Output
telegram_unpin_all_chat_messages
Input
Output
telegram_set_chat_title
Input
Output
telegram_set_chat_description
Input
Output
telegram_set_chat_permissions
Input
Output
telegram_export_chat_invite_link
Input
Output
telegram_create_chat_invite_link
Input
Output
telegram_edit_chat_invite_link
Input
Output
telegram_revoke_chat_invite_link
Input
Output
telegram_approve_chat_join_request
Input
Output
telegram_decline_chat_join_request
Input
Output
telegram_create_forum_topic
Input
Output
telegram_edit_forum_topic
Input
Output
telegram_close_forum_topic
Input
Output
telegram_reopen_forum_topic
Input
Output
telegram_delete_forum_topic
Input
Output
telegram_unpin_all_forum_topic_messages
Input
Output
telegram_get_forum_topic_icon_stickers
Input
Output
telegram_edit_general_forum_topic
Input
Output
telegram_close_general_forum_topic
Input
Output
telegram_reopen_general_forum_topic
Input
Output
telegram_hide_general_forum_topic
Input
Output
telegram_unhide_general_forum_topic
Input
Output
telegram_send_invoice
Input
Output
telegram_create_invoice_link
Input
Output
telegram_answer_pre_checkout_query
Input
Output
telegram_answer_shipping_query
Input
Output
telegram_refund_star_payment
Input
Output
telegram_get_star_transactions
Input
Output
telegram_get_my_star_balance
Input
Output
telegram_edit_user_star_subscription
Input
Output
telegram_gift_premium_subscription
Input
Output
telegram_set_chat_menu_button
Input
Output
telegram_get_chat_menu_button
Input
Output
telegram_answer_web_app_query
Input
Output
telegram_set_my_commands
Input
Output
telegram_get_my_commands
Input
Output
telegram_delete_my_commands
Input
Output
telegram_set_my_name
Input
Output
telegram_get_my_name
Input
Output
telegram_set_my_description
Input
Output
telegram_get_my_description
Input
Output
telegram_set_my_short_description
Input
Output
telegram_get_my_short_description
Input
Output
telegram_set_my_default_administrator_rights
Input
Output
telegram_get_my_default_administrator_rights
Input
Output
telegram_get_available_gifts
Input
Output
telegram_set_game_score
Input
Output
telegram_get_game_high_scores
Input
Output
telegram_delete_message
Input
Output
telegram_get_sticker_set
Input
Output
telegram_get_custom_emoji_stickers
Input
Output
telegram_upload_sticker_file
Input
Output
telegram_create_new_sticker_set
Input
Output
telegram_add_sticker_to_set
Input
Output
telegram_delete_sticker_from_set
Input
Output
telegram_set_sticker_position_in_set
Input
Output
telegram_set_sticker_set_thumbnail
Input
Output
telegram_delete_sticker_set
Input
Output
telegram_send_checklist
Input
Output
telegram_forward_messages
Input
Output
telegram_copy_messages
Input
Output
telegram_delete_messages
Input
Output
telegram_set_chat_photo
Input
Output
telegram_delete_chat_photo
Input
Output
telegram_set_chat_sticker_set
Input
Output
telegram_delete_chat_sticker_set
Input
Output
telegram_set_chat_member_tag
Input
Output
telegram_create_chat_subscription_invite_link
Input
Output
telegram_edit_chat_subscription_invite_link
Input
Output
telegram_unpin_all_general_forum_topic_messages
Input
Output
telegram_set_my_profile_photo
Input
Output
telegram_remove_my_profile_photo
Input
Output
telegram_log_out
Input
Output
telegram_close
Input
Output
telegram_get_user_chat_boosts
Input
Output
telegram_get_business_connection
Input
Output
telegram_get_user_personal_chat_messages
Input
Output
telegram_get_user_profile_audios
Input
Output
telegram_set_user_emoji_status
Input
Output
telegram_verify_user
Input
Output
telegram_verify_chat
Input
Output
telegram_remove_user_verification
Input
Output
telegram_remove_chat_verification
Input
Output
telegram_read_business_message
Input
Output
telegram_delete_business_messages
Input
Output
telegram_set_business_account_name
Input
Output
telegram_set_business_account_username
Input
Output
telegram_set_business_account_bio
Input
Output
telegram_set_business_account_profile_photo
Input
Output
telegram_remove_business_account_profile_photo
Input
Output
telegram_set_business_account_gift_settings
Input
Output
telegram_get_business_account_star_balance
Input
Output
telegram_transfer_business_account_stars
Input
Output
telegram_get_business_account_gifts
Input
Output
telegram_get_user_gifts
Input
Output
telegram_get_chat_gifts
Input
Output
telegram_convert_gift_to_stars
Input
Output
telegram_upgrade_gift
Input
Output
telegram_transfer_gift
Input
Output
telegram_set_sticker_emoji_list
Input
Output
telegram_set_sticker_keywords
Input
Output
telegram_set_sticker_mask_position
Input
Output
telegram_set_sticker_set_title
Input
Output
telegram_set_custom_emoji_sticker_set_thumbnail
Input
Output
telegram_replace_sticker_in_set
Input
Output
telegram_approve_suggested_post
Input
Output
telegram_decline_suggested_post
Input
Output
telegram_delete_message_reaction
Input
Output
telegram_delete_all_message_reactions
Input
Output
telegram_get_managed_bot_token
Input
Output
telegram_replace_managed_bot_token
Input
Output
telegram_get_managed_bot_access_settings
Input
Output
telegram_set_managed_bot_access_settings
Input
Output
telegram_save_prepared_inline_message
Input
Output
telegram_save_prepared_keyboard_button
Input
Output
telegram_edit_message_checklist
Input
Output
Start building today
Trusted by over 100,000 builders.
The SaaS platform to build AI agents and run your agentic workforce.
Get started