Telegram

Discover more about the Telegram connector and how to use it on the Digibee Integration Platform.

The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.

Telegram sends messages acting as a Telegram Bot API.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter	Description	Default value	Data type
Dynamic Account	When active, the connector will use the account dynamically. Otherwise, it will use the account statically.	False	Boolean
Account Name (DB)	The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.	N/A	String
Account	The account used by the connector. It is only available if the Dynamic Account parameter is inactive.	N/A	Account
Type	The endpoint type. Currently, only the “bots” type is supported.	N/A	String
Fail On Error	If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.	False	Boolean

Optional tab

Parameter	Description	Default value	Data type
Chat Id (DB)	The ID of the chat that is to receive the generated messages. Chat IDs can be first obtained from incoming messages (e.g. when a Telegram user starts a conversation with a bot, their client automatically sends a ‘/start’ message containing the chat ID). This is an optional parameter as the chat ID can be set dynamically for each outgoing message (using body or headers).	N/A	String
Base Uri (DB)	Can be used to set an alternative base URI, for example when you want to test the component against a mock Telegram API.	N/A	String
Buffer Size	The initial in-memory buffer size used when transferring data between Camel and AHC Client.	1048576	Integer
Proxy Type	HTTP proxy type which could be used when sending out the message.	HTTP	String
Body (DB)	The content of the message.	{}	JSON

Headers tab

Parameter	Description	Default value	Data type
Chat Id (DB)	This header is used by the producer endpoint in order to resolve the chat ID that will receive the message. The recipient chat ID can be placed (in order of priority) in the message body, in the CamelTelegramChatId header or in the endpoint configuration (chatId option). This header is also present in all incoming messages.	N/A	JSON
Media Title Caption (DB)	This header is used to provide a caption or title for outgoing binary messages.	N/A	String
Parse Mode	This header is used to format text messages using HTML or Markdown.	N/A	String
Message Timestamp	The message timestamp.	N/A	Integer

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Section for documenting any necessary information about the connector configuration and business rules.	N/A	String