Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Telegram is a messaging service for iOS, Android and other devices. A great advantage of Telegram is that it provides an open web service which can be used to send Telegram messages via software. More information about Telegram can be found here – the API documentation is available here

To send Telegram messages for the NETx BMS Server, the so called Bot API can be used. This is used to communicate with so called Telegram bots. Bots are special accounts that do not require a phone number. This tutorial explains how a Telegram Bot can be created and how the NETx BMS Server can send messages to this bot.

Info

In order to use this functionality, it is assumed that you have installed the Telegram app on your smart phone. The Telegram app can be download from Apple iTunes or Google Play Store. In addition, it is assumed to you have created a Telegram account. More information about Telegram can be found here.

Installation of the HTTP module

Sending messages to a Telegram bot is done via HTTP post requests. Therefore, the HTTP module of the NETx BMS Server has to be installed first. The installation of the HTTP module is done via the extension manager of the NETx BMS Server. For information about the installation of the HTTP module can be found here

Creating a Telegram bot

As next, a Telegram bot has to be created within your Telegram account. Bots can be created and managed with the "father" of all bots – the BotFather. The BothFather is a special bot that can be used by any account to create and manage your bots. 

...

Now you have created a new bot. To access a bot via the HTTP API, an authentication token is necessary. This token has to be send within the URL of each HTTP request. The token for your bot is shown within the chat after having created the bot. Write down the token – we will need it within the NETx BMS Server configuration afterwards.

Open a chat with your bot

After having created your bot, you have to open a chat with him. Click on search button within your Telegram app, enter your bot name and add him to your contact list. Afterwards, click on "start" to start the chat and send any message (e.g. "hello") to the bot.

...

As next we need to retrieve the so called chat_id. The chat_id is necessary to send messages via the HTTP API. To get the chat_id, open your webbrowser and the enter the following URL (<your bot token> has to be replaced by the authentication token of your bot):

...

Write down the id within the JSON object "chat" – we will need it afterwards within the NETx BMS Server.

Configuring the HTTP module

To a message to your bot via the HTTP API of telegram, the following HTTP POST GET request has to be used (<your bot token> has to be replaced by the authentication token of your bot):

...