Telegram¶

Node: telegram · Full type: n8n-nodes-base.telegram · Version: 1.2

Credentials¶

telegramApi (alias: @telegram)

CREDENTIAL @telegram = telegramApi "My Telegram"

Operations¶

Resource: `chat`¶

`get`¶

Parameter	Type	Default	Details
`chatId`	string	""	required

`administrators`¶

Parameter	Type	Default	Details
`chatId`	string	""	required

`member`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`userId`	string	""	required

`leave`¶

Parameter	Type	Default	Details
`chatId`	string	""	required

`setDescription`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`description`	string	""	required

`setTitle`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`title`	string	""	required

Resource: `callback`¶

`answerQuery`¶

Parameter	Type	Default	Details
`queryId`	string	""	required
`additionalFields`	collection	{}	keys: `cache_time`, `show_alert`, `text`, `url`

`answerInlineQuery`¶

Parameter	Type	Default	Details
`queryId`	string	""	required
`results`	string	""	required
`additionalFields`	collection	{}	keys: `cache_time`, `show_alert`, `text`, `url`

Resource: `file`¶

`get`¶

Parameter	Type	Default	Details
`fileId`	string	""	required
`download`	boolean	true
`additionalFields`	collection	{}	keys: `mimeType`

Resource: `message`¶

`deleteMessage`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`messageId`	string	""	required

`editMessageText`¶

Parameter	Type	Default	Details
`messageType`	options	"message"	`inlineMessage`, `message`
`chatId`	string	""	required
`messageId`	string	""	required
`inlineMessageId`	string	""	required
`replyMarkup`	options	"none"	`none`, `inlineKeyboard`
`text`	string	""	required
`additionalFields`	collection	{}	keys: `appendAttribution`, `caption`, `disable_notification`, `disable_web_page_preview`, `duration`, `fileName`, ...

`pinChatMessage`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`messageId`	string	""	required
`additionalFields`	collection	{}	keys: `disable_notification`

`sendAnimation`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`binaryData`	boolean	false	required
`binaryPropertyName`	string	"data"	required
`file`	string	""
`replyMarkup`	options	"none"	`forceReply`, `inlineKeyboard`, `none`, `replyKeyboard`, `replyKeyboardRemove`
`additionalFields`	collection	{}	keys: `appendAttribution`, `caption`, `disable_notification`, `disable_web_page_preview`, `duration`, `fileName`, ...

`sendAudio`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`binaryData`	boolean	false	required
`binaryPropertyName`	string	"data"	required
`file`	string	""
`replyMarkup`	options	"none"	`forceReply`, `inlineKeyboard`, `none`, `replyKeyboard`, `replyKeyboardRemove`
`additionalFields`	collection	{}	keys: `appendAttribution`, `caption`, `disable_notification`, `disable_web_page_preview`, `duration`, `fileName`, ...

`sendChatAction`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`action`	options	"typing"	`find_location`, `record_audio`, `record_video`, `record_video_note`, `typing`, `upload_audio`, `upload_document`, `upload_photo`, ... (10 total)

`sendDocument`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`binaryData`	boolean	false	required
`binaryPropertyName`	string	"data"	required
`file`	string	""
`replyMarkup`	options	"none"	`forceReply`, `inlineKeyboard`, `none`, `replyKeyboard`, `replyKeyboardRemove`
`additionalFields`	collection	{}	keys: `appendAttribution`, `caption`, `disable_notification`, `disable_web_page_preview`, `duration`, `fileName`, ...

`sendLocation`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`latitude`	number	0
`longitude`	number	0
`replyMarkup`	options	"none"	`forceReply`, `inlineKeyboard`, `none`, `replyKeyboard`, `replyKeyboardRemove`
`additionalFields`	collection	{}	keys: `appendAttribution`, `caption`, `disable_notification`, `disable_web_page_preview`, `duration`, `fileName`, ...

`sendMediaGroup`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`media`	fixedCollection	{}	groups: `media`
`additionalFields`	collection	{}	keys: `appendAttribution`, `caption`, `disable_notification`, `disable_web_page_preview`, `duration`, `fileName`, ...

`sendMessage`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`text`	string	""	required
`replyMarkup`	options	"none"	`forceReply`, `inlineKeyboard`, `none`, `replyKeyboard`, `replyKeyboardRemove`
`additionalFields`	collection	{}	keys: `appendAttribution`, `caption`, `disable_notification`, `disable_web_page_preview`, `duration`, `fileName`, ...

`sendAndWait`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`message`	string	""	required
`responseType`	options	"approval"	`approval`, `freeText`, `customForm`
`defineForm`	options	"fields"	`fields`, `json`
`jsonOutput`	json	"[
{
"fieldLabel": "Name",
"..."
`formFields`	fixedCollection	{}	groups: `values`
`formFields`	fixedCollection	{}	groups: `values`
`approvalOptions`	fixedCollection	{}	groups: `values`
`options`	collection	{}	keys: `limitWaitTime`, `appendAttribution`
`options`	collection	{}	keys: `messageButtonLabel`, `responseFormTitle`, `responseFormDescription`, `responseFormButtonLabel`, `responseFormCustomCss`, `limitWaitTime`, ...

`sendPhoto`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`binaryData`	boolean	false	required
`binaryPropertyName`	string	"data"	required
`file`	string	""
`replyMarkup`	options	"none"	`forceReply`, `inlineKeyboard`, `none`, `replyKeyboard`, `replyKeyboardRemove`
`additionalFields`	collection	{}	keys: `appendAttribution`, `caption`, `disable_notification`, `disable_web_page_preview`, `duration`, `fileName`, ...

`sendSticker`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`binaryData`	boolean	false	required
`binaryPropertyName`	string	"data"	required
`file`	string	""
`replyMarkup`	options	"none"	`forceReply`, `inlineKeyboard`, `none`, `replyKeyboard`, `replyKeyboardRemove`
`additionalFields`	collection	{}	keys: `appendAttribution`, `caption`, `disable_notification`, `disable_web_page_preview`, `duration`, `fileName`, ...

`sendVideo`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`binaryData`	boolean	false	required
`binaryPropertyName`	string	"data"	required
`file`	string	""
`replyMarkup`	options	"none"	`forceReply`, `inlineKeyboard`, `none`, `replyKeyboard`, `replyKeyboardRemove`
`additionalFields`	collection	{}	keys: `appendAttribution`, `caption`, `disable_notification`, `disable_web_page_preview`, `duration`, `fileName`, ...

`unpinChatMessage`¶

Parameter	Type	Default	Details
`chatId`	string	""	required
`messageId`	string	""	required

Common Parameters¶

Parameter	Type	Default	Details
`forceReply`	collection	{}	keys: `force_reply`, `selective`
`inlineKeyboard`	fixedCollection	{}	groups: `rows`
`replyKeyboard`	fixedCollection	{}	groups: `rows`
`replyKeyboardOptions`	collection	{}	keys: `resize_keyboard`, `one_time_keyboard`, `selective`
`replyKeyboardRemove`	collection	{}	keys: `remove_keyboard`, `selective`

Parameter Details¶

additionalFields children:

Parameter	Type	Default	Details
`disable_notification`	boolean	false

media children:

media group:

Parameter	Type	Default	Details
`type`	options	"photo"	`photo`, `video`
`media`	string	""
`additionalFields`	collection	{}	keys: `caption`, `parse_mode`

formFields children:

values group:

Parameter	Type	Default	Details
`fieldName`	string	""	required
`fieldLabel`	string	""	required
`fieldLabel`	string	""	required
`fieldName`	string	""
`fieldType`	options	"text"	required; `checkbox`, `html`, `date`, `dropdown`, `email`, `file`, `hiddenField`, `number`, ... (12 total)
`elementName`	string	""
`fieldName`	string	""
`placeholder`	string	""
`defaultValue`	string	""
`defaultValue`	dateTime	""
`defaultValue`	string	""
`defaultValue`	string	""
`fieldValue`	string	""
`fieldOptions`	fixedCollection	{...}	required; groups: `values`
`fieldOptions`	fixedCollection	{...}	required; groups: `values`
`fieldOptions`	fixedCollection	{...}	required; groups: `values`
`multiselect`	boolean	false
`limitSelection`	options	"unlimited"	`exact`, `range`, `unlimited`
`numberOfSelections`	number	1
`minSelections`	number	0
`maxSelections`	number	1
`html`	string	"

approvalOptions children:

values group:

Parameter	Type	Default	Details
`approvalType`	options	"single"	`single`, `double`
`approveLabel`	string	"✅ Approve"
`disapproveLabel`	string	"❌ Decline"

options children:

Parameter	Type	Default	Details
`limitWaitTime`	fixedCollection	{...}	groups: `values`
`appendAttribution`	boolean	true

forceReply children:

Parameter	Type	Default	Details
`force_reply`	boolean	false
`selective`	boolean	false

inlineKeyboard children:

rows group:

Parameter	Type	Default	Details
`row`	fixedCollection	{}	groups: `buttons`

replyKeyboard children:

rows group:

Parameter	Type	Default	Details
`row`	fixedCollection	{}	groups: `buttons`

replyKeyboardOptions children:

Parameter	Type	Default
`resize_keyboard`	boolean	false
`one_time_keyboard`	boolean	false
`selective`	boolean	false

replyKeyboardRemove children:

Parameter	Type	Default	Details
`remove_keyboard`	boolean	false
`selective`	boolean	false

Example¶

NODE "telegram" @telegram AS "Telegram" {
  resource: "chat",
  operation: "get",
  chatId: {{ $json.chatId }},
  messageId: {{ $json.messageId }},
  userId: {{ $json.userId }}
}

Telegram¶

Credentials¶

Operations¶

Resource: chat¶

get¶

administrators¶

member¶

leave¶

setDescription¶

setTitle¶

Resource: callback¶

answerQuery¶

answerInlineQuery¶

Resource: file¶

get¶

Resource: message¶

deleteMessage¶

editMessageText¶

pinChatMessage¶

sendAnimation¶

sendAudio¶

sendChatAction¶

sendDocument¶

sendLocation¶

sendMediaGroup¶

sendMessage¶

sendAndWait¶

sendPhoto¶

sendSticker¶

sendVideo¶

unpinChatMessage¶

Common Parameters¶

Parameter Details¶

Example¶

Resource: `chat`¶

`get`¶

`administrators`¶

`member`¶

`leave`¶

`setDescription`¶

`setTitle`¶

Resource: `callback`¶

`answerQuery`¶

`answerInlineQuery`¶

Resource: `file`¶

`get`¶

Resource: `message`¶

`deleteMessage`¶

`editMessageText`¶

`pinChatMessage`¶

`sendAnimation`¶

`sendAudio`¶

`sendChatAction`¶

`sendDocument`¶

`sendLocation`¶

`sendMediaGroup`¶

`sendMessage`¶

`sendAndWait`¶

`sendPhoto`¶

`sendSticker`¶

`sendVideo`¶

`unpinChatMessage`¶