Skip to main content

Telegram Plug-in

You can set the following properties in the configuration of the Telegram Bot plug-in:

PropertyDescription
NameAssign any unique name for your connection.

Section: Plug-in

PropertyDescription
Bot Access Token

The access token is provided by the “BotFather”:

  1. Open the Telegram app and select BotFather from your contacts.
  2. Request a new bot using the command /newbot .
  3. BotFather will now ask you for a name for your bot. You can choose any name you like.
  4. Next, BotFather will ask for a username. It must always end with _bot, e.g., Redaktion123_bot
  5. If the name is not already taken, BotFather will send you a confirmation and the AccessToken, which you should copy into the properties under the “Plugin” section.
  6. Enter the remaining properties and confirm your entries with “OK”.
Maximum file sizeThe maximum file size specifies (in MB) the maximum size of received files before the transfer is rejected.

The BotFather is used to manage Telegram bots. You can use BotFather to create, edit, and delete bots. Once you have created a bot, BotFather will provide you with the access token. You can retrieve the access token from BotFather at any time. The account that created a bot is the non-transferable owner of the bot. This section is for information purposes only; you do not need to enter anything in this area.

Section: BotFather

PropertyDescription
Help text

If you want to display automatic suggestions of possible commands to users, proceed as follows:

  1. Send “/setcommands” to the BotFather with the bot owner’s username.
  2. Send your bot name (@BotUsername) to the BotFather.
  3. Copy the help text from the “BotFather” section in your OPC router’s Telegram plugin and send it to the BotFather.
  4. Repeat the process after you have added, removed, or modified Telegram triggers.

Telegram bots are always displayed publicly and can be addressed by any Telegram user. Internal authentication filters out unauthenticated users before the triggers are activated.

Users can be manually authenticated after they have written to the bot (/start) or authenticate themselves using a previously generated confirmation code.

PropertyDescription
Authentication Method

Select the desired authentication method:

  • Authentication Method “None”: Telegram bots are always displayed publicly and can be contacted by any Telegram user without restrictions. No further settings are required.
  • “Internal” authentication method: Internal authentication filters out unauthenticated users before triggers are activated. Users can be manually authenticated after messaging the bot (/start) or by authenticating themselves using a pre-generated verification code.
note

Messages can only be sent to users who have already sent at least one message to the bot. Messages intended for everyone are sent to all registered users (including those who are not authenticated). However, a maximum of 30 messages per second may be sent (Telegram API limit).

Section: Registration

PropertyDescription
Authentication method
  • None: no authentication required (not recommended)
  • Internal: Users can be managed in the plug-in
  • FAS Login: Log in via FAS login.

For internal authentication method​

Section: Known users

PropertyDescription
Known UsersList of known users. Use the “Delete user” button to remove a user from the list. Use the “Revoke Permission” or “Grant Permission” buttons to revoke or assign permissions to known users.

Confirmation key section

PropertyDescription
Verification KeyDisplays the known verification keys. Use the “Delete registration code” and “Create validation code” buttons to remove verification keys from the list or add new ones.

For FAS login authentication method​

Section: Database

Here, connect the plug-in instance that can access the FAS login database.

Section: Email

Here, connect the plug-in instance that will be used to send registration emails.

Enter the sender address in the field and edit the email text.

Confirm your entries by selecting “OK” (Confirm).

Telegram plug-in

The following edit bots are helpful:

  • /setname - to change a bot name
  • /setdescription - to change a bot's description
  • /setabouttext - to change the bot's info
  • /setuserpic - to change a profile picture
  • /setcommands - to change the command list
  • /deletebot - to delete a bot
  • /setjoingroups - the bot may be added to groups
  • /setprivacy - the bot may see/read messages in groups