The Telegram component has no options. However, the Telegram component does support 24 endpoint options, which are listed below:

Size: px

Start display at page:

Download "The Telegram component has no options. However, the Telegram component does support 24 endpoint options, which are listed below:"

Alice Carter
6 years ago
Views:

1 Telegram Telegram Component 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 ca mel-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: <dependency> <groupid>org.apache.camel</groupid> <artifactid>camel-telegram</artifactid> <version>x.x.x</version>  </dependency> URI Format telegram:type/authorizationtoken[?options] Options The Telegram component has no options. However, the Telegram component does support 24 endpoint options, which are listed below: Name Group Default authorizationtoken common Required The authorization token for using the bot (ask the BotFather) e.g., :HGF_dT ra456323dhuoedse343211fqr3t-h. type common Required The endpoint type. Currently only the bots type is supported. bridgeerrorhandler consumer false 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 Limit on the number of updates that can be received in a single polling request. sendemptymessagewhenidle consumer false 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 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) To let the consumer use a custom ExceptionHandler. Note: 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.

2 pollstrategy consumer (advanced) 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 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 /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). exchangepattern advanced InOnly Sets the default exchange pattern when creating an exchange synchronous advanced false Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). backofferrorthreshold scheduler The number of subsequent error polls (failed due some error) that should happen before the back offmultiplier should kick-in. backoffidlethreshold scheduler The number of subsequent idle polls that should happen before the backoffmultiplier should kick-in. backoffmultiplier scheduler 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 backoffidlethreshold and/ or backofferrorthreshold must also be configured. delay scheduler 500 Milliseconds before the next poll. You can also specify time values using units such as: 60s (60 seconds) 5m30s (5 minutes and 30 seconds) 1h (1 hour) greedy scheduler false If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. initialdelay scheduler 1000 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) 1h (1 hour) runlogginglevel scheduler TRACE The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. scheduledexecutorservice scheduler 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 To use a cron scheduler from either camel-spring or camel-quartz2 component schedulerproperties scheduler To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. startscheduler scheduler true Whether the scheduler should be auto started. timeunit scheduler ms Time unit for initialdelay and delay options. usefixeddelay scheduler true Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. Message Headers Name CamelTelegramChatId CamelTelegramMediaType CamelTelegramMediaTitleCaption 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 CamelTe legramchatid header or in the endpoint configuration ( chatid option). This header is also present in all incoming messages. 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.com ponent.telegram.telegrammediatype enumeration. This header is used to provide a caption or title for outgoing binary messages. Usage

3 The Telegram component supports both consumer and producer endpoints. It can also be used in reactive chat-bot mode (to consume, then produce messages). 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: from("direct:start").to("telegram:bots/ :aae_dlq5c19xwgjw3yic2nveurzcejk21-q :aae_dlq5c19x womg5yic2nvsrkt3wj5q1-l"); or in Spring XML: <route> <from uri="direct:start"/> <to The code :AAE_dLq5C19xwGjw3yiC2NvEUrZcejK21-Q :AAE_dLq5C19xwOmg5yiC2NvSrkT3wj5Q1-L is the author ization 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 belon g to the package org.apache.camel.component.telegram.model) Java Type OutgoingTextMessage OutgoingPhotoMessage OutgoingAudioMessage OutgoingVideoMessage 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. 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 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: from("telegram:bots/ :aae_dlq5c19xwgjw3yic2nveurzcejk21-q :aae_dlq5c19 xwomg5yic2nvsrkt3wj5q1-l").bean(processorbean.class) or in Spring XML:

4 <route> <from <bean ref="mybean"/> <bean id="mybean" class="com.example.mybean"/> The MyBean is a simple bean that will receive the messages: 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 Java Type IncomingMessage String 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 from("telegram:bots/ :aae_dlq5c19xwgjw3yic2nveurzcejk21-q :aae_dlq5c19 xwomg5yic2nvsrkt3wj5q1-l").bean(chatbotlogic.class).to("telegram:bots/ :aae_dlq5c19xwgjw3yic2nveurzcejk21-q :aae_dlq5c19x womg5yic2nvsrkt3wj5q1-l"); or in Spring XML

5 <route> <from <bean ref="chatbotlogic"/> <to <bean id="chatbotlogic" class="com.example.chatbotlogic"/> The ChatBotLogic is a simple bean that implements a generic String-to-String method. 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 CamelTe legramchatid header is used to route the message).

BEAAquaLogic. Service Bus. Native MQ Transport User Guide

BEAAquaLogic. Service Bus. Native MQ Transport User Guide BEAAquaLogic Service Bus Native MQ Transport User Guide Version: 2.6 RP1 Revised: November 2007 Contents Introduction to the Native MQ Transport Advantages of Using the Native MQ Transport................................