telegram sink Telegram Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Send a message to a Telegram chat by using your Telegram bot as sender.

To create a bot, use your Telegram app to contact the @botfather account.

This sink supports the following message types:

  • Standard text messages

  • PNG images (Content-Type must be set to image/png)

  • JPEG images (Content-Type must be set to image/jpeg)

This sink also supports the following message headers:

  • text / ce-text: when sending an image, the image caption

  • chat-id / ce-chatid: overrides the default chat where messages are sent to

Configuration Options

The following table summarizes the configuration options available for the telegram-sink Kamelet:

Property Name Description Type Default Example

authorizationToken

Token

Required The token to access your bot on Telegram. You you can obtain it from the Telegram @botfather.

string

chatId

Chat ID

The Chat ID to where you want to send messages by default.

Whilst the Chat ID is not a required Configuration Option it must be provided for every message; either as a Configuration Option or a chat-id / ce-chatid header.

string

Dependencies

At runtime, the telegram-sink Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • camel:jackson

  • camel:kamelet

  • camel:telegram

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the telegram-sink.

Knative sink

You can use the telegram-sink Kamelet as a Knative sink by binding it to a Knative object.

telegram-sink-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: telegram-sink-pipe
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: telegram-sink
    properties:
      authorizationToken: The Token

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the telegram-sink-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f telegram-sink-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind channel:mychannel -p "sink.authorizationToken=The Token" telegram-sink

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka sink

You can use the telegram-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

telegram-sink-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: telegram-sink-pipe
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: telegram-sink
    properties:
      authorizationToken: The Token

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the telegram-sink-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f telegram-sink-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "sink.authorizationToken=The Token" telegram-sink

This command creates the Kamelet Pipe in the current namespace on the cluster.