Usage
Alarm Pipeline
Add a Notification Block with a Teltonika profile in your Alarm Pipeline.
Notification Block Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| Message | Expression | See below | Content of the SMS message to send |
Message Templates
Expression Syntax
The message field supports Ignition's expression syntax, allowing dynamic content based on alarm properties.
Default Message:
At {eventTime|hh:mm:ss}, alarm "{name}" at "{displayPath}" transitioned to {eventState}.
Available Variables
| Variable | Description | Example |
|---|---|---|
{name} | Alarm name | High Temperature |
{displayPath} | Alarm source path | Furnace/Zone1/TempSensor |
{eventTime|format} | Event timestamp with format | {eventTime|hh:mm:ss} |
{eventState} | Alarm state | Active, Cleared, Acknowledged |
{priority} | Alarm priority | High, Medium, Low |
{label} | Alarm label | Temperature Alarm |
Message Examples
Simple notification:
ALARM: {name} is {eventState} at {eventTime|HH:mm}
Detailed notification:
[{priority}] {name} at {displayPath} - State: {eventState} - Time: {eventTime|yyyy-MM-dd HH:mm:ss}
Concise alert:
{name}: {eventState}
Phone Number Handling
The module automatically converts phone numbers to the format required by Teltonika routers:
| Input Format | Converted Format |
|---|---|
+33612345678 | 0033612345678 |
+1234567890 | 001234567890 |
0612345678 | 0612345678 (unchanged) |
International Format
Always store phone numbers in international format (+XX...) in user contacts to ensure proper conversion.
API Communication
REST API Flow
1. POST /api/login
→ Receive token (cached for 5 minutes)
2. POST /api/messages/actions/send
Authorization: Bearer {token}
Body: { "data": { "number": "...", "message": "...", "modem": "..." } }
→ Receive success/failure response
Legacy API Flow
GET /cgi-bin/sms_send?username={user}&password={pass}&number={num}&text={msg}
→ Receive response
Audit Logging
When an audit profile is configured, all notification events are logged.
Logged information:
- Action: "Teltonika SMS"
- Actor: Ignition username receiving the notification
- Target: Alarm event path with ID
- Value: "SUCCESS" or "FAILURE"
- Timestamp
Troubleshooting
| Issue | Possible Cause | Solution |
|---|---|---|
| SMS not received | Invalid phone number | Verify number format in user contacts |
| SMS not received | No signal | Check router signal strength |
| SMS not received | SIM balance | Verify SIM has SMS credits |
| Authentication error (REST) | Wrong credentials | Verify username/password |
| Authentication error (REST) | Firmware too old | Switch to Legacy mode |
| "Modem required" error | Missing modem ID | Configure Modem field in profile |
| Token expired errors | Network latency | Module auto-refreshes tokens |
| License expired | Trial ended | Contact OperaMetrix for licensing |
Router Status Verification
To verify your router is ready to send SMS:
- Check Signal Strength - Router web interface > Status > Mobile
- Verify SIM Status - Ensure SIM is registered on network
- Test Manual SMS - Send a test SMS from router interface
- Check SMS Logs - Router web interface > Services > Mobile Utilities > SMS
Best Practices
- Test connectivity first - Verify Ignition can reach the router before configuring alarms
- Use REST API - Prefer REST API mode for better security and reliability
- Configure auditing - Enable audit logging for troubleshooting and compliance
- Monitor SIM balance - Set up alerts for low SMS credits
- Keep messages short - SMS has a 160 character limit (longer messages are split)
- Use international format - Store all phone numbers with country codes
- Dedicated SIM - Consider a dedicated SIM for alarm notifications