Available as of Camel 2.18
The Telegram component provides access to the Telegram Bot API. It allows a Camel-based application to send and receive messages by acting as a Bot, participating in direct conversations with normal users, private and public groups or channels.
A Telegram Bot must be created before using this component, following the instructions at the Telegram Bot developers home. When a new Bot is created, the BotFather provides an authorization token corresponding to the Bot. The authorization token is a mandatory parameter for the
In order to allow the Bot to receive all messages exchanged within a group or channel (not just the ones starting with a
/ character), ask the BotFather to disable the privacy mode, using the
Maven users will need to add the following dependency to their
pom.xml for this component:
The Telegram component has no options. However, the Telegram component does support 24 endpoint options, which are listed below:
Required The authorization token for using the bot (ask the BotFather) e.g.,
Required The endpoint type. Currently only the
Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the
Limit on the number of updates that can be received in a single polling request.
If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
Timeout in seconds for long polling. Put
To let the consumer use a custom
Note: if the option
The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages e.g., when a telegram user starts a conversation with a bot its client sends automatically a
Sets the default exchange pattern when creating an exchange
Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
The number of subsequent error polls (failed due some error) that should happen before the
The number of subsequent idle polls that should happen before the
To let the scheduled polling consumer back-off if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then
Milliseconds before the next poll. You can also specify time values using units such as:
If greedy is enabled then the
Milliseconds before the first poll starts. You can also specify time values using units such as:
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
To use a cron scheduler from either camel-spring or
To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
Whether the scheduler should be auto started.
Time unit for
Controls if fixed delay or fixed rate is used.
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 message body, in the
This header is used to identify the media type when the outgoing message is composed of pure binary data. Possible values are strings or enum values belonging to the
This header is used to provide a caption or title for outgoing binary messages.
The Telegram component supports both consumer and producer endpoints. It can also be used in reactive chat-bot mode (to consume, then produce messages).
The following is a basic example of how to send a message to a Telegram chat through the Telegram Bot API.
in Java DSL:
or in Spring XML:
123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L is the authorization token corresponding to the Bot.
When using the producer endpoint without specifying the chat id option, the target chat will be identified using information contained in the body or headers of the message. The following message bodies are allowed for a producer endpoint (messages of type
OutgoingXXXMessage belong to the package
To send a text message to a chat.
To send a photo (JPG, PNG) to a chat.
To send a mp3 audio to a chat.
To send a mp4 video to a chat.
To send any media type supported. It requires the
To send a text message to a chat. It gets converted automatically into a
The following is a basic example of how to receive all messages that telegram users are sending to the configured Bot.
In Java DSL:
or in Spring XML:
MyBean is a simple bean that will receive the messages:
Supported types for incoming messages are
The full object representation of an incoming message
The content of the message, for text messages only
Reactive Chat-Bot Example
The reactive chat-bot mode is a simple way of using the Camel component to build a simple chat bot that replies directly to chat messages received from the Telegram users.
The following is a basic configuration of the chat-bot in Java DSL
or in Spring XML
ChatBotLogic is a simple bean that implements a generic String-to-String method.
Every non-null string returned by the
chatBotProcess() method is automatically routed to the chat that originated the request (as the
CamelTelegramChatId header is used to route the message).