docs-v2

2.6 KiB

Raw Permalink Blame History

title

description

weight

flux/v0/tags

telegram.message() function

`telegram.message()` sends a single message to a Telegram channel using the [`sendMessage`](https://core.telegram.org/bots/api#sendmessage) method of the Telegram Bot API.

flux_v0_ref

name	parent	identifier
telegram.message	contrib/sranka/telegram	contrib/sranka/telegram/message

301

single notification

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

Function type signature

(
    channel: A,
    text: B,
    token: string,
    ?disableWebPagePreview: C,
    ?parseMode: D,
    ?silent: E,
    ?url: string,
) => int

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

url

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

token

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

channel

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

text

({{< req >}}) Message text.

parseMode

Parse mode of the message text. Default is MarkdownV2.

disableWebPagePreview

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

silent

Send message silently. Default is true.

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}**.")

2.6 KiB Raw Permalink Blame History