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.
Send messages to Telegram channels or users through the Telegram Bot API. Enables direct communication and notifications with message tracking and chat confirmation.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
text | string | Yes | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
data | object | Telegram message data |
↳ message_id | number | Unique Telegram message identifier |
↳ from | object | Chat information |
↳ id | number | Chat ID |
↳ is_bot | boolean | Whether the chat is a bot or not |
↳ first_name | string | Chat username (if available) |
↳ username | string | Chat title (for groups and channels) |
↳ chat | object | Information about the bot that sent the message |
↳ id | number | Bot user ID |
↳ first_name | string | Bot first name |
↳ username | string | Bot username |
↳ type | string | chat type private or channel |
↳ date | number | Unix timestamp when message was sent |
↳ text | string | Text content of the sent message |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
photo | string | Yes | No description |
caption | string | No | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
data | object | Telegram message data including optional photo(s) |
↳ message_id | number | Unique Telegram message identifier |
↳ from | object | Chat information |
↳ id | number | Chat ID |
↳ is_bot | boolean | Whether the chat is a bot or not |
↳ first_name | string | Chat username (if available) |
↳ username | string | Chat title (for groups and channels) |
↳ chat | object | Information about the bot that sent the message |
↳ id | number | Bot user ID |
↳ first_name | string | Bot first name |
↳ username | string | Bot username |
↳ type | string | Chat type (private, group, supergroup, channel) |
↳ date | number | Unix timestamp when message was sent |
↳ text | string | Text content of the sent message (if applicable) |
↳ photo | array | List of photos included in the message |
↳ file_id | string | Unique file ID of the photo |
↳ file_unique_id | string | Unique identifier for this file across different bots |
↳ file_size | number | Size of the photo file in bytes |
↳ width | number | Photo width in pixels |
↳ height | number | Photo height in pixels |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
video | string | Yes | No description |
caption | string | No | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
data | object | Telegram message data including optional media |
↳ message_id | number | Unique Telegram message identifier |
↳ from | object | Information about the sender |
↳ id | number | Sender ID |
↳ is_bot | boolean | Whether the chat is a bot or not |
↳ first_name | string | Sender's first name (if available) |
↳ username | string | Sender's username (if available) |
↳ chat | object | Information about the chat where message was sent |
↳ id | number | Chat ID |
↳ first_name | string | Chat first name (if private chat) |
↳ username | string | Chat username (for private or channels) |
↳ type | string | Type of chat (private, group, supergroup, or channel) |
↳ date | number | Unix timestamp when the message was sent |
↳ text | string | Text content of the sent message (if applicable) |
↳ format | object | Media format information (for videos, GIFs, etc.) |
↳ file_name | string | Media file name |
↳ mime_type | string | Media MIME type |
↳ duration | number | Duration of media in seconds |
↳ width | number | Media width in pixels |
↳ height | number | Media height in pixels |
↳ thumbnail | object | Thumbnail image details |
↳ file_id | string | Thumbnail file ID |
↳ file_unique_id | string | Unique thumbnail file identifier |
↳ file_size | number | Thumbnail file size in bytes |
↳ width | number | Thumbnail width in pixels |
↳ height | number | Thumbnail height in pixels |
↳ thumb | object | Secondary thumbnail details (duplicate of thumbnail) |
↳ file_id | string | Thumbnail file ID |
↳ file_unique_id | string | Unique thumbnail file identifier |
↳ file_size | number | Thumbnail file size in bytes |
↳ width | number | Thumbnail width in pixels |
↳ height | number | Thumbnail height in pixels |
↳ file_id | string | Media file ID |
↳ file_unique_id | string | Unique media file identifier |
↳ file_size | number | Size of media file in bytes |
↳ document | object | Document file details if the message contains a document |
↳ file_name | string | Document file name |
↳ mime_type | string | Document MIME type |
↳ thumbnail | object | Document thumbnail information |
↳ file_id | string | Thumbnail file ID |
↳ file_unique_id | string | Unique thumbnail file identifier |
↳ file_size | number | Thumbnail file size in bytes |
↳ width | number | Thumbnail width in pixels |
↳ height | number | Thumbnail height in pixels |
↳ thumb | object | Duplicate thumbnail info (used for compatibility) |
↳ file_id | string | Thumbnail file ID |
↳ file_unique_id | string | Unique thumbnail file identifier |
↳ file_size | number | Thumbnail file size in bytes |
↳ width | number | Thumbnail width in pixels |
↳ height | number | Thumbnail height in pixels |
↳ file_id | string | Document file ID |
↳ file_unique_id | string | Unique document file identifier |
↳ file_size | number | Size of document file in bytes |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
audio | string | Yes | No description |
caption | string | No | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
data | object | Telegram message data including voice/audio information |
↳ message_id | number | Unique Telegram message identifier |
↳ from | object | Information about the sender |
↳ id | number | Sender ID |
↳ is_bot | boolean | Whether the chat is a bot or not |
↳ first_name | string | Sender's first name (if available) |
↳ username | string | Sender's username (if available) |
↳ chat | object | Information about the chat where the message was sent |
↳ id | number | Chat ID |
↳ first_name | string | Chat first name (if private chat) |
↳ username | string | Chat username (for private or channels) |
↳ type | string | Type of chat (private, group, supergroup, or channel) |
↳ date | number | Unix timestamp when the message was sent |
↳ text | string | Text content of the sent message (if applicable) |
↳ audio | object | Audio file details |
↳ duration | number | Duration of the audio in seconds |
↳ performer | string | Performer of the audio |
↳ title | string | Title of the audio |
↳ file_name | string | Original filename of the audio |
↳ mime_type | string | MIME type of the audio file |
↳ file_id | string | Unique file identifier for this audio |
↳ file_unique_id | string | Unique identifier across different bots for this file |
↳ file_size | number | Size of the audio file in bytes |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
animation | string | Yes | No description |
caption | string | No | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
data | object | Telegram message data including optional media |
↳ message_id | number | Unique Telegram message identifier |
↳ from | object | Information about the sender |
↳ id | number | Sender ID |
↳ is_bot | boolean | Whether the chat is a bot or not |
↳ first_name | string | Sender's first name (if available) |
↳ username | string | Sender's username (if available) |
↳ chat | object | Information about the chat where message was sent |
↳ id | number | Chat ID |
↳ first_name | string | Chat first name (if private chat) |
↳ username | string | Chat username (for private or channels) |
↳ type | string | Type of chat (private, group, supergroup, or channel) |
↳ date | number | Unix timestamp when the message was sent |
↳ text | string | Text content of the sent message (if applicable) |
↳ format | object | Media format information (for videos, GIFs, etc.) |
↳ file_name | string | Media file name |
↳ mime_type | string | Media MIME type |
↳ duration | number | Duration of media in seconds |
↳ width | number | Media width in pixels |
↳ height | number | Media height in pixels |
↳ thumbnail | object | Thumbnail image details |
↳ file_id | string | Thumbnail file ID |
↳ file_unique_id | string | Unique thumbnail file identifier |
↳ file_size | number | Thumbnail file size in bytes |
↳ width | number | Thumbnail width in pixels |
↳ height | number | Thumbnail height in pixels |
↳ thumb | object | Secondary thumbnail details (duplicate of thumbnail) |
↳ file_id | string | Thumbnail file ID |
↳ file_unique_id | string | Unique thumbnail file identifier |
↳ file_size | number | Thumbnail file size in bytes |
↳ width | number | Thumbnail width in pixels |
↳ height | number | Thumbnail height in pixels |
↳ file_id | string | Media file ID |
↳ file_unique_id | string | Unique media file identifier |
↳ file_size | number | Size of media file in bytes |
↳ document | object | Document file details if the message contains a document |
↳ file_name | string | Document file name |
↳ mime_type | string | Document MIME type |
↳ thumbnail | object | Document thumbnail information |
↳ file_id | string | Thumbnail file ID |
↳ file_unique_id | string | Unique thumbnail file identifier |
↳ file_size | number | Thumbnail file size in bytes |
↳ width | number | Thumbnail width in pixels |
↳ height | number | Thumbnail height in pixels |
↳ thumb | object | Duplicate thumbnail info (used for compatibility) |
↳ file_id | string | Thumbnail file ID |
↳ file_unique_id | string | Unique thumbnail file identifier |
↳ file_size | number | Thumbnail file size in bytes |
↳ width | number | Thumbnail width in pixels |
↳ height | number | Thumbnail height in pixels |
↳ file_id | string | Document file ID |
↳ file_unique_id | string | Unique document file identifier |
↳ file_size | number | Size of document file in bytes |
Send documents (PDF, ZIP, DOC, etc.) to Telegram channels or users through the Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
files | file[] | No | No description |
caption | string | No | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
files | file[] | Files attached to the message |
data | object | Telegram message data including document |
↳ message_id | number | Unique Telegram message identifier |
↳ from | object | Information about the sender |
↳ id | number | Sender ID |
↳ is_bot | boolean | Whether the chat is a bot or not |
↳ first_name | string | Sender's first name (if available) |
↳ username | string | Sender's username (if available) |
↳ chat | object | Information about the chat where message was sent |
↳ id | number | Chat ID |
↳ first_name | string | Chat first name (if private chat) |
↳ username | string | Chat username (for private or channels) |
↳ type | string | Type of chat (private, group, supergroup, or channel) |
↳ date | number | Unix timestamp when the message was sent |
↳ document | object | Document file details |
↳ file_name | string | Document file name |
↳ mime_type | string | Document MIME type |
↳ file_id | string | Document file ID |
↳ file_unique_id | string | Unique document file identifier |
↳ file_size | number | Size of document file in bytes |
Send voice messages to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
voice | string | Yes | No description |
caption | string | No | No description |
duration | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent message object |
Send video notes (rounded video messages) to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
videoNote | string | Yes | No description |
duration | number | No | No description |
length | number | No | No description |
thumbnail | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent message object |
Send a group of media items (photos, videos, etc.) to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
media | string | Yes | JSON array of InputMedia objects |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent messages array |
Send stickers to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
sticker | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent message object |
Send geographic locations to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
latitude | number | Yes | No description |
longitude | number | Yes | No description |
livePeriod | number | No | No description |
heading | number | No | No description |
proximityAlertRadius | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent message object |
Send venue information to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
latitude | number | Yes | No description |
longitude | number | Yes | No description |
title | string | Yes | No description |
address | string | Yes | No description |
foursquareId | string | No | No description |
googlePlaceId | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent message object |
Send phone contacts to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
phoneNumber | string | Yes | No description |
firstName | string | Yes | No description |
lastName | string | No | No description |
vcard | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent message object |
Send polls to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
question | string | Yes | No description |
options | string | Yes | JSON array of answer options |
isAnonymous | boolean | No | No description |
type | string | No | No description |
allowsMultipleAnswers | boolean | No | No description |
correctOptionId | number | No | No description |
explanation | string | No | No description |
openPeriod | number | No | No description |
closeDate | number | No | No description |
isClosed | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent poll message object |
Send dice (or other animated emoji) to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
emoji | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent dice message object |
Send chat actions (typing, uploading, etc.) to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
action | string | Yes | typing, upload_photo, record_video, upload_video, record_voice, upload_voice, upload_document, choose_sticker, find_location, record_video_note, upload_video_note |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Chat action result |
Send games to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
gameShortName | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent game message object |
Send paid media (photos, videos, etc.) to Telegram channels through the Bot API for Telegram Stars.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
starCount | number | Yes | No description |
media | string | Yes | JSON array of InputPaidMedia |
payload | string | No | No description |
caption | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent paid media message object |
Send live photos (video + still image) to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
livePhoto | string | Yes | No description |
photo | string | Yes | No description |
caption | string | No | No description |
hasSpoiler | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent live photo message object |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | No | No description |
chatId | string | No | No description |
giftId | string | Yes | No description |
text | string | No | No description |
textParseMode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Forward messages between Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
fromChatId | string | Yes | No description |
messageId | string | Yes | No description |
disableNotification | boolean | No | No description |
protectContent | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent message object |
Copy messages between Telegram chats through the Bot API without the original formatting.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
fromChatId | string | Yes | No description |
messageId | string | Yes | No description |
caption | string | No | No description |
parseMode | string | No | No description |
disableNotification | boolean | No | No description |
protectContent | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | MessageId object |
Send a message draft (previously saved) to Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
draftId | number | Yes | No description |
text | string | No | No description |
parseMode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Sent message object |
Set reactions on messages in Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
reaction | string | No | JSON array of ReactionType |
isBig | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Reaction set result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
text | string | Yes | No description |
parseMode | string | No | No description |
linkPreviewOptions | json | No | No description |
replyMarkup | json | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Edited message object or True |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
caption | string | No | No description |
replyMarkup | json | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Edited message object or True |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
media | string | Yes | JSON object of InputMedia |
replyMarkup | json | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Edited message object or True |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
replyMarkup | json | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Edited message object or True |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
replyMarkup | json | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Stopped poll object |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
latitude | number | Yes | No description |
longitude | number | Yes | No description |
horizontalAccuracy | number | No | No description |
heading | number | No | No description |
proximityAlertRadius | number | No | No description |
replyMarkup | json | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Edited message object or True |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
replyMarkup | json | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Edited message object or True |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
callbackQueryId | string | Yes | No description |
text | string | No | No description |
showAlert | boolean | No | No description |
url | string | No | No description |
cacheTime | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
inlineQueryId | string | Yes | No description |
results | string | Yes | JSON array of InlineQueryResult objects |
cacheTime | number | No | No description |
isPersonal | boolean | No | No description |
nextOffset | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
guestQueryId | string | Yes | No description |
result | string | Yes | JSON object of InlineQueryResult |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
offset | number | No | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
fileId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | Yes | No description |
untilDate | number | No | No description |
revokeMessages | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | Yes | No description |
onlyIfBanned | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | Yes | No description |
permissions | string | Yes | No description |
untilDate | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | Yes | No description |
isAnonymous | boolean | No | No description |
canManageChat | boolean | No | No description |
canDeleteMessages | boolean | No | No description |
canManageVideoChats | boolean | No | No description |
canRestrictMembers | boolean | No | No description |
canPromoteMembers | boolean | No | No description |
canChangeInfo | boolean | No | No description |
canInviteUsers | boolean | No | No description |
canPostMessages | boolean | No | No description |
canEditMessages | boolean | No | No description |
canPinMessages | boolean | No | No description |
canManageTopics | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | Yes | No description |
customTitle | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
senderChatId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
senderChatId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
disableNotification | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
title | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
description | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
permissions | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
name | string | No | No description |
expireDate | number | No | No description |
memberLimit | number | No | No description |
createsJoinRequest | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
inviteLink | string | Yes | No description |
name | string | No | No description |
expireDate | number | No | No description |
memberLimit | number | No | No description |
createsJoinRequest | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
inviteLink | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
name | string | Yes | No description |
iconColor | number | No | No description |
iconCustomEmojiId | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageThreadId | number | Yes | No description |
name | string | No | No description |
iconCustomEmojiId | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageThreadId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageThreadId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageThreadId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageThreadId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
name | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Send a payment invoice to a Telegram chat. Supports both real payments (requires provider_token) and Telegram Stars (XTR currency, no provider_token needed).
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
title | string | Yes | No description |
description | string | Yes | No description |
payload | string | Yes | No description |
providerToken | string | No | No description |
currency | string | Yes | No description |
prices | string | Yes | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
data | object | Telegram message object for the sent invoice |
↳ message_id | number | Invoice message ID |
↳ date | number | Unix 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).
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
title | string | Yes | No description |
description | string | Yes | No description |
payload | string | Yes | No description |
providerToken | string | No | No description |
currency | string | Yes | No description |
prices | string | Yes | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
invoiceLink | string | Generated invoice payment link URL |
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.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
preCheckoutQueryId | string | Yes | No description |
ok | boolean | Yes | No description |
errorMessage | string | No | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
result | boolean | True if the answer was accepted by Telegram |
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.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
shippingQueryId | string | Yes | No description |
ok | boolean | Yes | No description |
shippingOptions | string | No | No description |
errorMessage | string | No | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
result | boolean | True if the answer was accepted by Telegram |
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.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | string | Yes | No description |
telegramPaymentChargeId | string | Yes | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
result | boolean | True if the refund was processed successfully |
Retrieve the history of Telegram Stars (XTR) transactions for the bot. Returns a paginated list of StarTransaction objects ordered by date descending.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
offset | number | No | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
transactions | object | StarTransactions object containing the list of transactions |
↳ transactions | array | Array of StarTransaction objects |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
telegramPaymentChargeId | string | Yes | No description |
isCanceled | boolean | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
monthCount | number | Yes | No description |
starCount | number | Yes | No description |
text | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the bot
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | No | No description |
buttonType | string | Yes | No description |
buttonText | string | No | No description |
webAppUrl | string | No | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
result | boolean | True if the menu button was updated |
Retrieve the current menu button for a private chat or the bot
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | No | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
menuButton | object | MenuButton object describing the current menu button |
↳ type | string | Button type: default, commands, or web_app |
↳ text | string | Button text (only for web_app type) |
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.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
webAppQueryId | string | Yes | No description |
result | string | Yes | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
sentWebAppMessage | object | SentWebAppMessage object with the inline_message_id |
↳ inline_message_id | string | Identifier of the sent inline message |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
commands | string | Yes | No description |
scope | string | No | No description |
languageCode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
scope | string | No | No description |
languageCode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
scope | string | No | No description |
languageCode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
name | string | No | No description |
languageCode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
languageCode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
description | string | No | No description |
languageCode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
languageCode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
shortDescription | string | No | No description |
languageCode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
languageCode | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
rights | string | No | JSON object of ChatAdministratorRights |
forChannels | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
forChannels | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
ok | boolean | API response success status |
result | json | Complete message result object from Telegram API |
message | string | Success or error message |
data | json | Response data |
files | file[] | Files attached to the message |
messageId | number | Sent message ID |
chatId | number | Chat ID where message was sent |
chatType | string | Type of chat (private, group, supergroup, channel) |
username | string | Chat username (if available) |
messageDate | number | Unix timestamp of sent message |
messageText | string | Text content of sent message |
deleted | boolean | Whether the message was successfully deleted |
invoiceLink | string | Generated invoice link URL |
transactions | json | StarTransactions result object |
menuButton | json | Current MenuButton object |
sentWebAppMessage | json | SentWebAppMessage with inline_message_id |
update_id | number | Unique identifier for the update |
message_id | number | Unique message identifier from webhook |
from_id | number | User ID who sent the message |
from_username | string | Username of the sender |
from_first_name | string | First name of the sender |
from_last_name | string | Last name of the sender |
chat_id | number | Unique identifier for the chat |
chat_type | string | Type of chat (private, group, supergroup, channel) |
chat_title | string | Title of the chat (for groups and channels) |
text | string | Message text content from webhook |
date | number | Date the message was sent (Unix timestamp) |
entities | json | Special entities in the message (mentions, hashtags, etc.) |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
chatId | string | No | No description |
messageId | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Array of GameHighScore objects |
Delete messages in Telegram channels or chats through the Telegram Bot API. Requires the message ID of the message to delete.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | string | Yes | No description |
| Parameter | Type | Description |
|---|
message | string | Success or error message |
data | object | Delete operation result |
↳ ok | boolean | API response success status |
↳ deleted | boolean | Whether the message was successfully deleted |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
name | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
customEmojiIds | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
sticker | string | Yes | No description |
stickerFormat | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
name | string | Yes | No description |
title | string | Yes | No description |
stickers | string | Yes | No description |
stickerType | string | No | No description |
needsRepainting | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
name | string | Yes | No description |
sticker | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
sticker | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
sticker | string | Yes | No description |
position | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
name | string | Yes | No description |
userId | number | Yes | No description |
thumbnail | string | No | No description |
format | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
name | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Send a checklist message in a Telegram Bot API business connection.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
chatId | string | Yes | No description |
checklist | string | Yes | JSON object of InputChecklist |
disableNotification | boolean | No | No description |
protectContent | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Forward multiple messages between Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
fromChatId | string | Yes | No description |
messageIds | string | Yes | JSON array of message IDs |
disableNotification | boolean | No | No description |
protectContent | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Forwarded messages result |
Copy multiple messages between Telegram chats through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
fromChatId | string | Yes | No description |
messageIds | string | Yes | JSON array of message IDs |
disableNotification | boolean | No | No description |
protectContent | boolean | No | No description |
removeCaption | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Copied messages result |
Delete multiple messages in a Telegram chat through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageIds | string | Yes | JSON array of message IDs |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Delete messages result |
Set a new profile photo for a Telegram chat through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
photo | string | Yes | URL or file_id of new photo |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Set chat photo result |
Delete the profile photo of a Telegram chat through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Delete chat photo result |
Set the sticker set for a Telegram supergroup chat through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
stickerSetName | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Set chat sticker set result |
Delete the sticker set of a Telegram supergroup chat through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Delete chat sticker set result |
Set a tag on a member in a Telegram chat through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | Yes | No description |
tag | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Set chat member tag result |
Create a subscription invite link for a Telegram chat through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
subscriptionPeriod | number | Yes | No description |
subscriptionPrice | number | Yes | No description |
name | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Created subscription invite link object |
Edit a subscription invite link for a Telegram chat through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
inviteLink | string | Yes | No description |
name | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Edited subscription invite link object |
Unpin all messages in the general forum topic of a Telegram chat through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Unpin all general forum topic messages result |
Set the profile photo for the bot through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
photo | string | Yes | JSON object of InputProfilePhoto |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Set my profile photo result |
Remove the profile photo of the bot through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Remove my profile photo result |
Log out from the Telegram Bot API server.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Close the bot instance on the Telegram Bot API server.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Get the list of boosts a user has given to a Telegram chat through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | User chat boosts list |
Get information about a Telegram business connection through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Business connection object |
Get messages from user personal chats through the Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
limit | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | User personal chat messages |
Get profile audios of a Telegram user through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
offset | number | No | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | User profile audios |
Set the emoji status for a Telegram user through the Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
emojiStatusCustomEmojiId | string | No | No description |
emojiStatusExpirationDate | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Set user emoji status result |
Verify a user in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
customDescription | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Verify a chat in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
customDescription | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Remove verification from a user in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Remove verification from a chat in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Read a business message in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
chatId | number | Yes | No description |
messageId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Delete multiple business messages in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
messageIds | string | Yes | JSON array of message IDs |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the name of a business account in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
firstName | string | Yes | No description |
lastName | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the username of a business account in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
username | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the bio of a business account in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
bio | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the profile photo of a business account in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
photo | string | Yes | JSON object of InputProfilePhoto |
isPublic | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Remove the profile photo of a business account in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
isPublic | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the gift settings of a business account in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
showGiftButton | boolean | Yes | No description |
acceptedGiftTypes | string | Yes | JSON object of AcceptedGiftTypes |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Get the star balance of a business account in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Business account star balance |
Transfer stars from a business account in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
starCount | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Get gifts of a business account in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
excludeUnsaved | boolean | No | No description |
excludeSaved | boolean | No | No description |
excludeUnlimited | boolean | No | No description |
excludeLimitedUpgradable | boolean | No | No description |
excludeLimitedNonUpgradable | boolean | No | No description |
excludeUnique | boolean | No | No description |
excludeFromBlockchain | boolean | No | No description |
sortByPrice | boolean | No | No description |
offset | string | No | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Get gifts owned by a user in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
excludeUnlimited | boolean | No | No description |
excludeLimitedUpgradable | boolean | No | No description |
excludeLimitedNonUpgradable | boolean | No | No description |
excludeUnique | boolean | No | No description |
sortByPrice | boolean | No | No description |
offset | string | No | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Get gifts owned by a chat in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
excludeUnsaved | boolean | No | No description |
excludeSaved | boolean | No | No description |
excludeUnlimited | boolean | No | No description |
excludeLimitedUpgradable | boolean | No | No description |
excludeLimitedNonUpgradable | boolean | No | No description |
excludeUnique | boolean | No | No description |
sortByPrice | boolean | No | No description |
offset | string | No | No description |
limit | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Convert a gift to Telegram Stars in a business connection.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
ownedGiftId | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Upgrade a gift in a Telegram Bot API business connection.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
ownedGiftId | string | Yes | No description |
keepOriginalDetails | boolean | No | No description |
starCount | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Transfer a gift to a new owner in a Telegram Bot API business connection.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
ownedGiftId | string | Yes | No description |
newOwnerChatId | number | Yes | No description |
starCount | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the emoji list for a sticker in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
sticker | string | Yes | No description |
emojiList | string | Yes | JSON array of emoji |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the keywords for a sticker in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
sticker | string | Yes | No description |
keywords | string | No | JSON array of keywords |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the mask position for a sticker in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
sticker | string | Yes | No description |
maskPosition | string | No | JSON object of MaskPosition |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the title of a sticker set in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
name | string | Yes | No description |
title | string | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set the thumbnail for a custom emoji sticker set in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
name | string | Yes | No description |
customEmojiId | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Replace a sticker in a sticker set in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
name | string | Yes | No description |
oldSticker | string | Yes | No description |
sticker | string | Yes | JSON object of InputSticker |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Approve a suggested post in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | number | Yes | No description |
messageId | number | Yes | No description |
sendDate | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Decline a suggested post in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | number | Yes | No description |
messageId | number | Yes | No description |
comment | string | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Delete a reaction from a message in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
userId | number | No | No description |
actorChatId | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Delete all reactions from a message in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
chatId | string | Yes | No description |
userId | number | No | No description |
actorChatId | number | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Get the token of a managed bot in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | Managed bot token |
Replace the token of a managed bot in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Get access settings of a managed bot for a user in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Set access settings of a managed bot for a user in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
isAccessRestricted | boolean | Yes | No description |
addedUserIds | string | No | JSON array of user IDs |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Save a prepared inline message in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
result | string | Yes | JSON object of InlineQueryResult |
allowUserChats | boolean | No | No description |
allowBotChats | boolean | No | No description |
allowGroupChats | boolean | No | No description |
allowChannelChats | boolean | No | No description |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Save a prepared keyboard button for a user in Telegram Bot API.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
userId | number | Yes | No description |
button | string | Yes | JSON object of KeyboardButton |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |
Edit the checklist of a message in a Telegram Bot API business connection.
| Parameter | Type | Required | Description |
|---|
botToken | string | Yes | No description |
businessConnectionId | string | Yes | No description |
chatId | string | Yes | No description |
messageId | number | Yes | No description |
checklist | string | Yes | JSON object of InputChecklist |
| Parameter | Type | Description |
|---|
ok | boolean | Success status |
result | json | API response result |