Documentation for Axxon One 2.0. Documentation for other versions of Axxon One is available too.

Previous page Push notification  Voice notification from сlient Next page

General information

Axxon One allows you to send text notifications to Telegram chat when any event occurs from the objects registered in the Axxon One object tree. Once configured, the notification sending is initiated by a macro.

Before configuring notifications sending from Axxon One to Telegram, create a bot and a group chat with this bot in Telegram. For the distribution package and manuals on working with Telegram, see the developer's official website telegram.org.

Note

For the correct operation of Telegram bot and notification sending, the user who created the bot must have @username specified in Telegram.

Configuring an action

To configure notification sending via Telegram bot, do the following:

  1. Go to the Programming tab.
  2. In the Event rules or Cycle rules list, click Create... (see Configuring macros).
  3. Select a start condition that triggers a macro (see Configuring start conditions).
  4. Click the  button below start conditions.
  5. From the drop-down list, select General: Execute web query.

  6. In the Authentication method parameter, select the authentication method:
    1. Basic (default);
    2. Digest.
  7. In the Command parameter, select the query type:
    1. POST (defaul);
    2. GET;
    3. PUT;
    4. DELETE.
  8. In the HTTP/HTTPS parameter, select the server protocol:
    1. HTTP;
    2. HTTPS.

      Attention!

      For the correct notifications sending, you must select the HTTPS protocol.

  9. In the IP address parameter, enter the IP address of the Telegram server—api.telegram.org.
  10. In the Port parameter, enter the port of the Telegram server—443. 
  11. In the Path parameter, enter the path of the query. The path of the query must look like this: /bot<BOTToken>/sendMessage?chat_id=<СhatID>&&text=<Text>, where <BOTToken> is an ID of the bot in Telegram;

    Note

    The ID is provided when you create the bot

    <СhatID> is the ID of the chat;

    Note

    To learn the ID of the chat, add the @RawDataBot bot to the chat. After adding, the bot will send a message to the chat that will contain the result of the execution of the getUpdates function. Find ChatId in the message. Then remove the @RawDataBot bot from the chat.

    <Text> is a notification text. You can enter the set of US-ASCII characters (Latin characters and digits) in the notification text. For the notification text to display correctly with other characters and punctuation marks, you need to encode them. The encoding is described in the RFC 3986 standard and called URL-encoding, URLencoded, or percent-encoding. For example, a space character is encoded as %20.

  12. Click the Apply button.

Configuration of the General: Execute web query action is complete.

When  you use the General: Execute web query action, all fields for sending a web query to the specified server can be filled in (see Execute web query). However, the Username, Password and Query fields are not required for sending a notification via Telegram bot.

  • No labels