--- apiVersion: v1 kind: List items: - apiVersion: v1 kind: ConfigMap metadata: labels: funktion.fabric8.io/kind: Connector provider: fabric8 project: connector-telegram version: 1.1.20 group: io.fabric8.funktion.connector name: telegram data: deployment.yml: | --- apiVersion: extensions/v1beta1 kind: Deployment metadata: labels: funktion.fabric8.io/kind: Subscription connector: telegram spec: replicas: 1 template: metadata: labels: funktion.fabric8.io/kind: Subscription connector: telegram spec: containers: - image: fabric8/connector-telegram:1.1.20 name: connector schema.yml: | --- component: kind: component scheme: telegram syntax: telegram:type/authorizationToken title: Telegram description: The telegram component provides access to the Telegram Bot API. label: chat deprecated: false async: false javaType: org.apache.camel.component.telegram.TelegramComponent groupId: org.apache.camel artifactId: camel-telegram version: 2.18.1 componentProperties: authorizationToken: kind: property type: string javaType: java.lang.String deprecated: false secret: false description: The default Telegram authorization token to be used when the information is not provided in the endpoints. properties: type: kind: path group: common required: true type: string javaType: java.lang.String enum: - bots deprecated: false secret: false description: The endpoint type. Currently only the 'bots' type is supported. authorizationToken: kind: path group: common required: true type: string javaType: java.lang.String deprecated: false secret: false description: The authorization token for using the bot (ask the BotFather) eg. 654321531:HGF_dTra456323dHuOedsE343211fqr3t-H. bridgeErrorHandler: kind: parameter group: consumer label: consumer type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: false description: 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 org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. limit: kind: parameter group: consumer label: consumer type: integer javaType: java.lang.Integer optionalPrefix: consumer. deprecated: false secret: false defaultValue: "100" description: Limit on the number of updates that can be received in a single polling request. sendEmptyMessageWhenIdle: kind: parameter group: consumer label: consumer type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: false description: If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. timeout: kind: parameter group: consumer label: consumer type: integer javaType: java.lang.Integer optionalPrefix: consumer. deprecated: false secret: false defaultValue: "30" description: Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time. exceptionHandler: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.spi.ExceptionHandler optionalPrefix: consumer. deprecated: false secret: false description: To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. exchangePattern: kind: parameter group: consumer (advanced) label: consumer,advanced type: string javaType: org.apache.camel.ExchangePattern enum: - InOnly - RobustInOnly - InOut - InOptionalOut - OutOnly - RobustOutOnly - OutIn - OutOptionalIn deprecated: false secret: false description: Sets the exchange pattern when the consumer creates an exchange. pollStrategy: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.spi.PollingConsumerPollStrategy optionalPrefix: consumer. deprecated: false secret: false description: A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. chatId: kind: parameter group: producer label: producer type: string javaType: java.lang.String deprecated: false secret: false description: The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot its client sends automatically a '/start' message containing the chat id). It is an optional parameter as the chat id can be set dynamically for each outgoing message (using body or headers). synchronous: kind: parameter group: advanced label: advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). backoffErrorThreshold: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: int optionalPrefix: consumer. deprecated: false secret: false description: The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. backoffIdleThreshold: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: int optionalPrefix: consumer. deprecated: false secret: false description: The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. backoffMultiplier: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: int optionalPrefix: consumer. deprecated: false secret: false description: To let the scheduled polling consumer backoff 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 backoffIdleThreshold and/or backoffErrorThreshold must also be configured. delay: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: long optionalPrefix: consumer. deprecated: false secret: false defaultValue: "500" description: Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). greedy: kind: parameter group: scheduler label: consumer,scheduler type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: false description: If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. initialDelay: kind: parameter group: scheduler label: consumer,scheduler type: integer javaType: long optionalPrefix: consumer. deprecated: false secret: false defaultValue: "1000" description: Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). runLoggingLevel: kind: parameter group: scheduler label: consumer,scheduler type: string javaType: org.apache.camel.LoggingLevel enum: - TRACE - DEBUG - INFO - WARN - ERROR - OFF optionalPrefix: consumer. deprecated: false secret: false defaultValue: TRACE description: The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. scheduledExecutorService: kind: parameter group: scheduler label: consumer,scheduler type: object javaType: java.util.concurrent.ScheduledExecutorService optionalPrefix: consumer. deprecated: false secret: false description: Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. scheduler: kind: parameter group: scheduler label: consumer,scheduler type: string javaType: org.apache.camel.spi.ScheduledPollConsumerScheduler enum: - none - spring - quartz2 optionalPrefix: consumer. deprecated: false secret: false defaultValue: none description: To use a cron scheduler from either camel-spring or camel-quartz2 component schedulerProperties: kind: parameter group: scheduler label: consumer,scheduler type: object javaType: java.util.Map prefix: scheduler. multiValue: true deprecated: false secret: false description: To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. startScheduler: kind: parameter group: scheduler label: consumer,scheduler type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: true description: Whether the scheduler should be auto started. timeUnit: kind: parameter group: scheduler label: consumer,scheduler type: string javaType: java.util.concurrent.TimeUnit enum: - NANOSECONDS - MICROSECONDS - MILLISECONDS - SECONDS - MINUTES - HOURS - DAYS optionalPrefix: consumer. deprecated: false secret: false defaultValue: MILLISECONDS description: Time unit for initialDelay and delay options. useFixedDelay: kind: parameter group: scheduler label: consumer,scheduler type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: true description: Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. documentation.adoc: | [[Telegram-TelegramComponent]] Telegram Component ~~~~~~~~~~~~~~~~~~ *Available as of Camel 2.18* The *Telegram* component provides access to the https://core.telegram.org/bots/api[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 link:https://core.telegram.org/bots#3-how-do-i-create-a-bot[Telegram Bot developers home]. When a new Bot is created, the link:https://telegram.me/botfather[BotFather] provides an **authorization token** corresponding to the Bot. The authorization token is a mandatory parameter for the camel-telegram endpoint. NOTE: 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 */setprivacy* command. Maven users will need to add the following dependency to their `pom.xml` for this component: [source,xml] ------------------------------------------------------------ org.apache.camel camel-telegram x.x.x ------------------------------------------------------------ [[Telegram-URIformat]] URI format ^^^^^^^^^^ [source,java] ---------------------------------------------------- telegram:type/authorizationToken[?options] ---------------------------------------------------- You can append query options to the URI in the following format, `?option=value&option=value&...` [[Telegram-Options]] Options ^^^^^^^ // component options: START The Telegram component supports 1 options which are listed below. {% raw %} [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description | authorizationToken | String | The default Telegram authorization token to be used when the information is not provided in the endpoints. |======================================================================= {% endraw %} // component options: END // endpoint options: START The Telegram component supports 24 endpoint options which are listed below: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description | type | common | | String | *Required* The endpoint type. Currently only the 'bots' type is supported. | authorizationToken | common | | String | *Required* The authorization token for using the bot (ask the BotFather) eg. 654321531:HGF_dTra456323dHuOedsE343211fqr3t-H. | bridgeErrorHandler | consumer | false | boolean | 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 org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. | limit | consumer | 100 | Integer | Limit on the number of updates that can be received in a single polling request. | sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | timeout | consumer | 30 | Integer | Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. | pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | chatId | producer | | String | The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot its client sends automatically a '/start' message containing the chat id). It is an optional parameter as the chat id can be set dynamically for each outgoing message (using body or headers). | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff 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 backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component | schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. | timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. | useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= {% endraw %} // endpoint options: END [[Telegram-MessageHeaders]] Message Headers ^^^^^^^^^^^^^^^ [width="100%",cols="20%,80%",options="header",] |======================================================================= |Name |Description |`CamelTelegramChatId` |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 `CamelTelegramChatId` header or in the endpoint configuration (`chatId` option). This header is also present in all incoming messages. |`CamelTelegramMediaType` |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 `org.apache.camel.component.telegram.TelegramMediaType` enumeration. |`CamelTelegramMediaTitleCaption` |This header is used to provide a caption or title for outgoing binary messages. |======================================================================= [[Telegram-Usage]] Usage ^^^^^ The Telegram component supports both consumer and producer endpoints. It can also be used in *reactive chat-bot mode* (to consume, then produce messages). [[Telegram-ProducerExample]] Producer Example ^^^^^^^^^^^^^^^^ The following is a basic example of how to send a message to a Telegram chat through the Telegram Bot API. in Java DSL [source,java] --------------------------------------------------------- from("direct:start").to("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L"); --------------------------------------------------------- or in Spring XML [source,xml] --------------------------------------------- --------------------------------------------- The code `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 `org.apache.camel.component.telegram.model`) [width="100%",cols="40%,60%",options="header",] |=================================================== | Java Type | Description | `OutgoingTextMessage` | To send a text message to a chat | `OutgoingPhotoMessage` | To send a photo (JPG, PNG) to a chat | `OutgoingAudioMessage` | To send a mp3 audio to a chat | `OutgoingVideoMessage` | To send a mp4 video to a chat | `byte[]` | To send any media type supported. It requires the `CamelTelegramMediaType` header to be set to the appropriate media type | `String` | To send a text message to a chat. It gets converted automatically into a `OutgoingTextMessage` |=================================================== [[Telegram-ConsumerExample]] Consumer Example ^^^^^^^^^^^^^^^^ The following is a basic example of how to receive all messages that telegram users are sending to the configured Bot. In Java DSL [source,java] --------------------------------------------------------- from("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L") .bean(ProcessorBean.class) --------------------------------------------------------- or in Spring XML [source,xml] --------------------------------------------- --------------------------------------------- The `MyBean` is a simple bean that will receive the messages [source,java] --------------------------------------------------------- public class MyBean { public void process(String message) { // or Exchange, or org.apache.camel.component.telegram.model.IncomingMessage (or both) // do process } } --------------------------------------------------------- Supported types for incoming messages are [width="100%",cols="40%,60%",options="header",] |=================================================== | Java Type | Description | `IncomingMessage` | The full object representation of an incoming message | `String` | The content of the message, for text messages only |=================================================== [[Telegram-ReactiveChatBot]] 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 [source,java] --------------------------------------------------------- from("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L") .bean(ChatBotLogic.class) .to("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L"); --------------------------------------------------------- or in Spring XML [source,xml] --------------------------------------------- --------------------------------------------- The `ChatBotLogic` is a simple bean that implements a generic String-to-String method. [source,java] --------------------------------------------------------- public class ChatBotLogic { public String chatBotProcess(String message) { if( "do-not-reply".equals(message) ) { return null; // no response in the chat } return "echo from the bot: " + message; // echoes the message } } --------------------------------------------------------- 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). [[Telegram-GettingTheChatId]] Getting the Chat ID ^^^^^^^^^^^^^^^^^^^ If you want to push messages to a specific Telegram chat when an event occurs, you need to retrieve the corresponding chat ID. The chat ID is not currently shown in the telegram client, but you can obtain it using a simple route. First, add the bot to the chat where you want to push messages, then run a route like the following one. [source,java] --------------------------------------------------------- from("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L") .to("log:INFO?showHeaders=true"); --------------------------------------------------------- Any message received by the bot will be dumped to your log together with information about the chat (`CamelTelegramChatId` header). Once you get the chat ID, you can use the following sample route to push message to it. [source,java] --------------------------------------------------------- from("timer:tick") .setBody().constant("Hello") to("telegram:bots/123456789:AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q987654321:AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L?chatId=123456") --------------------------------------------------------- Note that the corresponding URI parameter is simply `chatId`.