[…]
alert:
- "smseagle"
smseagle_url: "https://192.168.1.101"
smseagle_token: "123abc456def789"
smseagle_message_type: "sms"
smseagle_to: ["+123456789", "987654321"]
smseagle_contacts: [2, 7]
[…]
ElastAlert2 SMS alerts and notifications – integration manual
Here we describe how to send SMS alerts from ElastAlert2 using SMSEagle Hardware SMS Gateway.
SMSEagle is an offline hardware SMS gateway. Therefore, no external connection to 3rd party system is required. All notifications are generated on-premise and sent directly to a cellular network. This solution can be used in secure installations without Internet access.
Setup is easy and should take 10-15 min to complete.
SMSEagle Setup
- Create a new user in SMSEagle (menu Users > + Add Users, user access level: “User”).
- Grant API access to the created user:
- click Access to API next to the newly created user
- Enable APIv2
- Generate new token
- For text messages, add access permissions in section Messages for: Send SMS
- For voice call alerting, add access permissions in section Calls for: Make a ring call, Make a TTS call, Make a TTS Advanced call.
- Save settings
ElastAlert2 Setup
To use SMSEagle alerter, simply type-in its configuration in your alert rule.
Example configuration in YAML file:
Available parameters are:
Required:
- smseagle_url: Address of your SMSEagle device, e.g. http://192.168.1.101
- smseagle_token: API access token (per user, can be generated in menu Users > Access to API)
- smseagle_message_type: Message/call type to send/queue. Available values: sms, ring, tts, tts_adv respectively for SMS, Ring call, TTS call and Advanced TTS call.
Required one of:
- smseagle_to: Phone number(s) to which you want to send a message
- smseagle_contacts: Name(s) of contact(s) from the SMSEagle Phonebook to which you want to send a message
- smseagle_groups: Name(s) of group(s) from the SMSEagle Phonebook to which you want to send a message
Optional:
- smseagle_duration: Call duration, required for Ring, TTS and Advanced TTS call. Default value: 10
- smseagle_voice_id: ID of the voice model, required for Advanced TTS call. Default value: 1
- smseagle_text: Override notification text with a custom one
More information can be found in the Elastalert2 documentation here: https://elastalert2.readthedocs.io/en/latest/alerts.html#smseagle
Explore SMSEagle Demo device
SMSEagle is a hardware & software solution that guarantees a swift delivery of your messages to designated recipients, whether it’s for notifications, alerts, or important updates.
After registering to a demo you get a remote access to our physical device NXS-9750.
- 14-days free trial
- Access to over 20 functionalities
