docs-v2/content/influxdb/cloud/reference/flux/stdlib/contrib/telegram/message.md

2.4 KiB

title description menu weight
telegram.message() function The `telegram.message()` function sends a single message to a Telegram channel using the [`sendMessage` method of the Telegram Bot API](https://core.telegram.org/bots/api#sendmessage).
influxdb_cloud_ref
name parent
telegram.message Telegram
202

The telegram.message() function sends a single message to a Telegram channel using the sendMessage method of the Telegram Bot API.

Function type: Output

import "contrib/sranka/telegram"

telegram.message(
  url: "https://api.telegram.org/bot",
  token: "S3crEtTel3gRamT0k3n",
  channel: "-12345",
  text: "Example message text",
  parseMode: "MarkdownV2",
  disableWebPagePreview: false,
  silent: true
)

{{% note %}} For information about retrieving your Telegram bot token and channel ID, see Set up a Telegram bot. {{% /note %}}

Parameters

url

URL of the Telegram bot endpoint. Default is https://api.telegram.org/bot.

Data type: String

token

({{< req >}}) Telegram bot token.

Data type: String

channel

({{< req >}}) Telegram channel ID.

Data type: String

text

Message text.

Data type: String

parseMode

Parse mode of the message text. Default is "MarkdownV2".

Data type: String

disableWebPagePreview

Disable preview of web links in the sent message. Default is false.

Data type: Boolean

silent

Send message silently. Default is true.

Data type: Boolean

Examples

Send the last reported status to Telegram
import "influxdata/influxdb/secrets"
import "contrib/sranka/telegram"

token = secrets.get(key: "TELEGRAM_TOKEN")

lastReported =
  from(bucket: "example-bucket")
    |> range(start: -1m)
    |> filter(fn: (r) => r._measurement == "statuses")
    |> last()
    |> findRecord(fn: (key) => true, idx: 0)

    telegram.message(
      token: token,
      channel: "-12345"
      text: "Disk usage is **${lastReported.status}**.",
    )

{{% note %}}

Package author and maintainer

Github: @sranka
InfluxDB Slack: @sranka {{% /note %}}