Telegram Bot - Version 2.0.0#

Module Summary#

Interact with Telegram messaging as a bot

Module Status#

This IO Module is stable and has been tested internally.

If you encounter any issues with this module, or have any feedback regarding its operation, please contact our support team.

Release Notes#

Version 2.0#

  •  Initial release.

Minor point releases (eg. 1.1.x) will be for small fixes and may not be listed here.

Operation#

Instance Properties#

Set the Token to the unique authentication token obtained from Telegram’s @BotFather. Details on how to obtain this token can be found here: https://core.telegram.org/bots/features#botfather

Checking the Extended Logging checkbox will provide more detailed log messages. This is intended for diagnostics and problem solving and should ideally be disabled during normal operation.

Status Variables#

The IO Modules tab of the web interface provides status variables to shows information about the module and monitor its state.

ID User ID of the bot
Name Public name of the bot
Username Public username of the bot

Triggers#

Received Message#

Fires when the Controller receives a text message which has been sent to the bot, either directly, or via a group or channel the bot has been added to.

The message matching property can include variable captures, e.g. Test<d><d> would match with Test12 and return the captured Variables 1 and 2. For full details of the available capture patterns, please refer to the Designer manual section Variables.

Matching properties:

  •  Chat Type: Matching Chat Type, or Any.

  •  Chat Name: Matching Chat Name, or any if empty.

  •  Chat ID: Matching Chat ID, or any if empty.

  •  Message: Matching Text message, or any if empty.

Trigger variables:

  •  Variable 1: Chat ID (string).

  •  Variable 2: Chat Type: “private”, “group”, “supergroup”, “channel” (string).

  •  Variable 3: Chat Name (string).

  •  Variable 4: Message (string).

  •  Variable 5…n: Optional captured variables (Variant).

Actions#

Send Message#

Sends a text Message to the Chat ID.

(Note: A bot can only send a Message to a Chat ID that it has been added to. Unsolicited messages can not be sent to individual users.)

The Chat ID is the ID of a Telegram Group or Channel. In the case of a public group or channel that is the name of the channel in the form @channelName.

In the case of a private group or channel, it is a number which represents the private group or channel. Consult additional documentation for information on how to get this ID number.

Support#

If you encounter any issues with this module, please contact our support team.