Configuration

Ignition 8.1 build

This page documents configuration for the Ignition 8.1 build of the Teltonika module. Some options available in later releases are not present here. For the current release, see the latest documentation.

Alarm Notification Profile

After installing the module, create an Alarm Notification Profile of type Teltonika Notification under Config > Alarming > Notification.

The profile settings are grouped into the following categories.

Gateway

Parameter	Type	Required	Description
Host	Text	Yes	IP address or hostname of the Teltonika router. Include a non-standard port here (e.g. 192.168.1.1:8080); communication is always plain HTTP.

Credentials

Parameter	Type	Required	Description
Username	Text	Yes	Router authentication username
Password	Password (masked)	Yes	Router authentication password

Password storage

In this 8.1 build the Password is stored as a standard string field with a masked password editor in the UI. It is not stored using Ignition's secret/encrypted field type.

Auditing

Parameter	Type	Required	Description
Audit Profile	Dropdown	No	If selected, alarm notification attempts are stored to the audit system.

Advanced

Parameter	Type	Required	Default	Description
Legacy Mode	Boolean	Yes	false	Use the legacy Teltonika API with basic URL-based authentication.
Modem Name	Text	Conditional	—	Name of the modem to use when sending via the REST API. Required when Legacy Mode is false.

Modem required in REST mode

When Legacy Mode is false (REST API), the Modem Name field must not be empty. The profile fails to start with the error "'Modem' field cannot be empty when using the REST API (Legacy = false)." if it is left blank. In Legacy mode the Modem field is ignored.

---

API Modes

The module supports two API modes, selected by the Legacy Mode checkbox.

REST API Mode (Legacy Mode = false, default)

Modern Teltonika firmware uses a token-based REST API.

Requirements:

• Firmware with REST API support
• Modem Name must be configured

Flow:

1. POST http://<Host>/api/login with a JSON body {"username":"...","password":"..."}
2. The token is read from data.token in the response and cached for ~5 minutes (299 seconds)
3. SMS is sent with POST http://<Host>/api/messages/actions/send, using an Authorization: Bearer <token> header and a JSON body containing number, message, and modem
4. Success is determined from the success field in the response

Legacy API Mode (Legacy Mode = true)

Older firmware uses URL-based authentication.

Flow:

• GET http://<Host>/cgi-bin/sms_send with username, password, number, and text passed as URL query parameters
• The Modem Name field is not used in this mode

Which mode to use?

Try REST API mode first. If your router firmware does not support the token API, enable Legacy Mode.

---

User Contact Configuration

The profile supports only the SMS contact type. For a user to receive Teltonika notifications, their contact info must include an SMS phone number.

1. Navigate to Config > Security > Users, Roles
2. Edit the user
3. In the Contact Info section, add a contact of type SMS
4. Enter the phone number in international format (e.g., +33612345678)

Phone number normalization

Before sending, the module replaces the first character of the stored number with 00. A stored value beginning with + (e.g. +33612345678) becomes 0033612345678. Because it always strips the first character and prepends 00, store numbers in international + format for correct results. See Usage for details.

---

Per-Alarm Custom Message

The module registers an Extended Configuration property so a message can be overridden per alarm.

1. Open the alarm (tag alarm) configuration in the Designer
2. In the alarm's Extended Config, find the Teltonika Notification Properties category
3. Set the Custom Message property

If a Custom Message is specified, it is used instead of the notification block's Message template for that alarm. If blank, the notification block's Message is used.

---

Auditing

When an Audit Profile is selected, each notification attempt writes an audit record per alarm event:

Field	Value
Action	Teltonika Message
Actor	Path of the Ignition user being notified
Actor Host	The notification profile name
Target	Alarm source path extended with the alarm event ID
Value	SUCCESS or FAILURE
Originating System	Alarming
Timestamp	Time of the notification attempt