Page 2
Congratulations on purchasing SMSEAGLE The materials used in this publication are copyright and are not to be duplicated, copied, or used without the prior consent of the copyright holder. Technical specifications and information in this document are subject to change without prior notice being given.
CONTENTS SMSEagle Software Licensing Information ...................... 10 What’s In The Box ..............................16 Prepare for First Start ............................. 17 Get to know with Connectors, Ports and LEDs ....................22 Basic Operations............................... 23 SMSEagle basic features ............................24 Compose SMS ............................... 24 Importing SMS from CSV and using placeholders ..................
YOU AGREE TO BE LEGALLY BOUND BY THE HEREIN-CONTAINED TERMS OF THIS LICENSE AGREEMENT. IF YOU DO NOT AGREE TO BE BOUND BY THE TERMS OF THIS EULA, DO NOT USE THE SMSEAGLE DEVICE AND YOU MAY CHOOSE TO PROMPTLY RETURN THE DEVICE FOR A REFUND OF ITS PURCHASE PRICE BY CONTACTING PROXIMUS AT THE ADDRESS ABOVE.
Page 11
1.04 "Update" means maintenance of, or a fix to, a version of SMSEagle Software, including, but not limited to a hot fix, patch, or enhancement, none of which function as a standalone service or other software package and which do not have an additional cost for an existing Licensee.
Page 12
Intellectual Property laws and treaties. 3.02 RESTRICTIONS ON USE. As a Licensee, You may not: (a) Make use of the SMSEagle Software on more than one device at a time, without prior purchase of additional devices; (b) Share or otherwise make available the SMSEagle Software, in any manner whatsoever, to any third party (c) Modify, adapt, create derivative works from or translate any part of the SMSEagle Software other than what may be used within Your SMSEagle device in accordance with this License;...
Page 13
FOR A PARTICULAR USE, AND NONINFRINGEMENT. LIMITATION OF LIABILITY AND REMEDIES IN SPITE OF ANY DAMAGES ARISING FROM OR RELATED TO THE SMSEAGLE DEVICE AND SMSEAGLE SOFTWARE OR ITS OPERATION THAT YOU MAY INCUR FOR ANY REASON, WHICH MAY INCLUDE, BUT ARE NOT LIMITED TO, ANY AND ALL DAMAGES IN CONTRACT, TORT OR...
Page 14
DATA COLLECTION STATEMENT. PROXIMUS does NOT collect ANY data you are working with when You use SMSEagle device. We could not see or collect any data saved on SMSEagle device, because we do not have any access to Your device.
Page 15
CONTACT INFORMATION If you have questions regarding this EULA, please contact PROXIMUS at: Proximus Sp. z o.o. Ul. Piątkowska 163 60-650 Poznań Poland | Europe tel. + 48 61 6713 413 https:/ /www.smseagle.eu hello@smseagle.eu support@smseagle.eu | SMSEagle NXS-9700 | User’s Manual...
PREPARE FOR FIRST START Your SMSEagle is designed so that you can set it up quickly and start using it right away. Follow the steps below to get started. Install 3G/4G antenna STEP 1: ANTENNA INSTALLATION GUIDELINES Install the antenna in a location with access to a cellular network radio signal.
Page 18
SMSEAGLE DEFAULT NETWORK CONFIGURATION: DHCP CLIENT IS ON IP ADDRESS WILL BE OBTAINED AUTOMATICALLY FROM YOUR DHCP SERVER CONNECT SMSEAGLE TO YOUR LAN AND OBTAIN IP ADDRESS AUTOMATICALLY connect the device to your LAN using Ethernet cable • SMSEagle will obtain IP address automatically from your DHCP •...
Page 19
PREPARE FOR FIRST START LOG IN TO SMSEAGLE Open an internet browser on your PC and go to the IP address assigned to your gateway SMSEAGLE DEFAULT USER: Username: admin Password: password Login to application with above username and password.
Page 20
SSL certificate or a free Let’s Encrypt SSL certificate. Using HTTPS only By default, SMSEagle webGUI can be accessed via HTTP or HTTPS. For improved security we recommend using HTTPS. If you would like to redirect HTTP > HTTPS, follow instructions in the chapter SSL Certificate and HTTPS Redirection.
Page 21
USING OF SMSEAGLE | SMSEagle NXS-9700 | User’s Manual...
LED for user application purpose SIM1,2 LEDs Modem 1,2 (optional) LED indicator for modem status Ready LED LED indication device status Reset Switch for rebooting the device User Switch Switch for restoring to factory settings | SMSEagle NXS-9700 | User’s Manual...
SMSEagle is capable of working at various screen resolutions, making it accessible for wide range of devices: computers, laptops, tablets, smartphones, etc. Open a web browser on your device, type in SMSEagle’s IP address (as set in previous chapter). At login screen type in your username/password. Default username and password is given in chapter Prepare for First Start.
Importing SMS from CSV and using placeholders SMSEagle software allows you to import SMS text from CSV file and (optionally) use special placeholders in a message body. Placeholders are special fields which are replaced with unique values for each message.
• Trash • The view of conversations can be either of type “Balloons” (smartphone like conversation) or “Table” (tabular view). The view type can be changed in menu Settings > Application. Balloons view type: | SMSEagle NXS-9700 | User’s Manual...
Purging interval (daily, weekly, monthly or annually) • Set the time • Select the folder (Inbox, Outbox or Sent Items) • Set time span of messages • Select to delete modem log files • | SMSEagle NXS-9700 | User’s Manual...
Phonebook Web-GUI of SMSEagle device is equipped with Phonebook for managing contacts, groups and shifts. Each user can create private and public contacts, gather contacts in private and public groups. Contacts can also be optionally assigned to working shifts. Contacts and groups from Phonebook allows users efficient sending of messages.
In Phonebook Group Management view users can: Add/edit/delete groups • Set groups to public or private visbility • Set group escalation • View group content (contacts beloning to the group) • Send message to a group • | SMSEagle NXS-9700 | User’s Manual...
STOP word is received. Screenshot from Manage Group view You can change the escalation order by dragging contacts up or down. Screenshot from Manage Groups with set escalation | SMSEagle NXS-9700 | User’s Manual...
There are two access levels for a user: User role “Administrator”: • Allows full access & control of the device including settings and User management. User role “User”: • Limits access only allowing to Compose, Folders, Phonebook and Reporting module. | SMSEagle NXS-9700 | User’s Manual...
Screenshot of Edit/Add User window Multi-User Capabilities As described in the “Users” chapter, SMSEagle software allows to create multiple users with different access leves (Administrator or User). Those users may access the device simultaneously via webGUI or API. The following set of features is available in multi-user work scenario: Multiple users may acess the device simultaneously via webGUI or API •...
Statistics view The reporting module allows also to view daily statistics of sent/received messages. The statistics view displays number of messages per day and sender/receiver number. Screenshot of Statistics view in Reporting module Multi-Factor Authentication | SMSEagle NXS-9700 | User’s Manual...
Page 35
USER LOGIN WITH MFA Once MFA is activated, the user must provide two factor authentication (user and password + one-time SMS token) every time he logs in to Web-GUI. One-time SMS token is valid for 10 minutes. | SMSEagle NXS-9700 | User’s Manual...
Page 36
Screenshot from User Settings > MFA. Recovery code is revealed after entering password ENABLE MFA BY ADMINISTRATOR MFA can also be enabled by an administrator role for selected users. This is done in the menu Users > Edit User. | SMSEagle NXS-9700 | User’s Manual...
Screenshot from Edit/Add User Settings Settings menu is divided into several tabs for easier maintenance. Application Settings Application settings can be changed under the Settings Tab > Application. | SMSEagle NXS-9700 | User’s Manual...
You can enable/disable Password complexity verification. When enabled user password must be at • least 8 characters long and include at least one lowercase letter, uppercase letter, number and special character IP Settings IP settings can be changed under the Settings tab > IP Settings. | SMSEagle NXS-9700 | User’s Manual...
You can input Hostname • You can choose to Use proxy • Failover Failover configuration has been described in chapter “Failover (HA-cluster) feature”. Date/Time Date/Time settings can be changed under the Settings Tab > Date/Time | SMSEagle NXS-9700 | User’s Manual...
NTP server on SMSEagled device (date & time will be obtained from 3G/4G network) You can set NTP timeserver address • Maintenance Maintenance settings can be accessed under the Settings tab > Maintenance | SMSEagle NXS-9700 | User’s Manual...
Email Alerts feature allows to send email alert message to a selected email address once SMS sending errors occurs. When a defined error counter threshold is reached, alert email is triggered. The feature can be accessed under Settings tab > Email Alerts | SMSEagle NXS-9700 | User’s Manual...
Page 42
You can save debug information in system log (enable this only for troubleshooting) • Notice: To prevent false alarms we recommend to set parameter “Send alert when error counter exceeds” to value > 2. | SMSEagle NXS-9700 | User’s Manual...
Call forward settings can be accessed under the Settings tab > Call forward. You can choose to forward all incoming calls to a chosen number • MMS Settings can be accessed under the Settings tab > MMS. | SMSEagle NXS-9700 | User’s Manual...
Here you can control a mobile data connection on your device. It can be used, for example, to utilize SMSEagle as a backup Internet source. Data connection is NOT REQUIRED for normal operation of SMSEagle device. Leave it disabled (OFF) if you don't want to use it.
HTTP to HTTPS traffic. SSL Certificate BY default, SMSEagle device is equipped with a self-signed SSL certificate. If you want to install your own certificate on the device, please obtain a valid certificate file issued by a Certificate Authority. To upload the certificate, please provide the certificate file and private key in PEM format.
This file should be uploaded together with SSL certificate. Backup/Restore Backup and restore settings can be accessed under the Settings tab > Backup/Restore You can create a backup of your device settings • You can enable automatic backup to SFTP/FTP(S) • | SMSEagle NXS-9700 | User’s Manual...
Update settings can be accessed under the menu Settings > Updates tab. SMSEagle software is under process of continual improvement. We listen to our customers, and new releases are based on our customer’s inputs/requests. Software updates are released frequently, and offer access to new features and fixes to reported issues.
Page 48
A month before expiration of a support package your device will notify you about the upcoming expiration date and conveniently provide a link to our online store and sales partners where you can renew your package. Screenshot from “General Settings-Updates” | SMSEagle NXS-9700 | User’s Manual...
Page 49
Notice: Your SMSEagle device must have a HTTPS connectivity with the address updates.smseagle.eu in order for this feature to work. | SMSEagle NXS-9700 | User’s Manual...
SMSEagle NXS-family devices have their own failover mechanism based on HA-cluster. This feature allows you to assure high availability of SMSEagle devices in critical environments. To enable failover (HA-cluster) you need 2 devices ('aka' nodes). The failover feature monitors devices working in the cluster, and detects faults with the following services: 1.
Page 51
When the daemon running at MASTER device detects failure of at least one described feature it immediately automatically switches cluster's IP assignment to the BACKUP device (node) providing continuous usage of the SMSEagle HA-cluster for the user. Devices (nodes) should see each other on the network. By default, HA-nodes use 224.0.0.18 multicast IP address for VRRP (Virtual Router Redundancy Protocol) for communication between two nodes.
Page 52
Failover feature uses KEEPALIVED-MIB for SNMP monitoring. DEVICE CLUSTER STATE EXAMPLE OF READING VALUE USING NET-SNMP LIBRARY a) Command for reading the result value: snmpget -v 2c -c public ip-of-smseagle .1.3.6.1.4.1.9586.100.5.2.3.1.4.1 Result: KEEPALIVED-MIB::vrrpInstanceState.1 = INTEGER: master(2) Comment: Current device state is master | SMSEagle NXS-9700...
Basic features of SMSEagle software are extended by plugins that provide extra features to the software. Below you will find a description of plugins available in each SMSEagle device. All plugins are an integral part of SMSEagle software. That means that all described plugins are installed in a standard software of SMSEagle device and are available for free.
Page 54
ICMP (ping) to monitor a server with ICMP protocol • or PORT (TCP/UDP) to monitor your service on a selected port (SMSEagle will check if port is open) • or SNMP to monitor objects via SNMP protocol (supported return types: numeric, string) •...
Page 55
MONITORING FREQUENCY Monitoring tasks are performed in a parallel mode. Software automatically optimizes number of parallel tasks and frequency of tasks taking into account the performance of the device and adjusts monitoring period when needed. | SMSEagle NXS-9700 | User’s Manual...
Page 56
What makes the Trap unique is that they are triggered instantaneously by an agent, rather than waiting for a status request from SNMP get query. Screenshot from Network Monitor > SNMP TRAPS window. | SMSEagle NXS-9700 | User’s Manual...
The text of the email is the text of the SMS message (optionally you can append email subject at the beginning of SMS message). Example: email message sent to the address: 123456789@192.168.0.101 will be converted to SMS message and delivered to phone number 123456789. | SMSEagle NXS-9700 | User’s Manual...
Page 58
LDAP plugin must be configured on your SMSEagle device. USING FQDN IN EMAIL ADDRESS It is also possible to use Fully Qualified Domain Name in an email address sent to SMSEagle box (eg.: 123456789@mydomain.com). Please refer to our FAQ article:...
Page 59
Screenshot from Email To SMS > Rules window Screenshot from Email to SMS > Add new rule You can name your rule • You can set forwarding to Always or For specified senders / when email contains • | SMSEagle NXS-9700 | User’s Manual...
If you enabled contacts from LDAP, define Phone number for LDAP errors. Alerts about errors with • LDAP connection will be sent to this phone number after 3 unsuccessful LDAP connection attempts. Leave this field empty for not alerts Email to SMS Poller | SMSEagle NXS-9700 | User’s Manual...
Page 61
SMS message to +48333444555 mobile number. SEND TO USERNAME/GROUP If you want to send SMS to a contact or group from SMSEagle phonebook, put the contact/group name in SUBJECT field. Notice: Messages that are processed by Email2SMS Poller (but not deleted) are marked in the mailbox as read. Software is based on flagging messages- Read/Unread.
Page 62
Screenshot from Email to SMS Poller > Add new rule You can name your rule • You can set forwarding to Always or For specified senders / when email contains • | SMSEagle NXS-9700 | User’s Manual...
If you want to send as MMS, select always or only when email contains an attachment • SMS to Email plugin SMS to Email plugin allows you to forward incoming SMS messages to email address. The plugin can be used in two modes: | SMSEagle NXS-9700 | User’s Manual...
Page 64
SMS to email of last sender (so called Two-way Email2SMS & SMS2Email) In this mode, when SMSEagle receives incoming SMS, it checks if earlier anyone was sending SMS to the number from incoming SMS using Emai2SMS. If last sender is found, the incoming SMS is forwarded to the email address of last sender.
Page 65
SMS (and phonebook contact name if found) • Date, time when SMS is received • SMS message • Example email text sent from plugin: From: +483334455 (John Doe) Received: 2017-06-01 14:38:12 Message: My SMS message | SMSEagle NXS-9700 | User’s Manual...
• phone number or name of group from phonebook. User may define many forwarding rules in the plugin. • Each rule is processed independently. • There is a possibility to enable/disable each rule. • | SMSEagle NXS-9700 | User’s Manual...
Callback URL plugin allows you to forward incoming SMS message to a defined URL address. If the plugin is enabled, on each incoming SMS message SMSEagle will trigger HTTP(S) request to a defined URL. HTTP(S) request can be of type GET or POST.
Page 68
After sending HTTP(S) GET/POST request to your callback URL, SMSEagle will be expecting HTTP response: 200 [OK]. If other or no response is received from your callback URL, SMSEagle will keep retrying every X minute for 24 hours. Retry interval can be set in main plugin Window: | SMSEagle NXS-9700 | User’s Manual...
Sending interval (Hourly, Daily, Weekly, Monthly or Annually) • Message type (SMS, USSD Code) • The content of the SMS text • The recipients (phone number(s) separated with comma or group(s) from phonebook) • | SMSEagle NXS-9700 | User’s Manual...
Plugin “Autoreply” allows to add many autoreply rules. Each rule can be enabled or disabled by user. Screenshot from plugin main window For each rule user can define: • When autoreply message should be sent: | SMSEagle NXS-9700 | User’s Manual...
Screenshot form “Add/edit autoreply rule” Digital input/output The NXS- family of SMSEagle devices is equipped with digital inputs (DI) and digital outputs (DO). The digital inputs can be used to receive signals from outside sensors or devices and automatically trigger sending of SMS message based on input state.
Page 72
Port type Hardware Rev.3 Hardware Rev.2, Rev.1 The logical states of inputs and outputs of SMSEagle NXS-family of devices are represented by the following states: Logical level Hardware Rev.3 Hardware Rev. 2, Rev.1 LOW (0) +5 V HIGH (1) +5 V...
Page 73
Digital Output - example of usage with external relay Digital USING DIGITAL INPUTS Digital inputs (DI) of SMSEagle device are of type “pull-up resistor”. This type of input is used to prevent accidental switching of digital circuits. In order to achieve it any unconnected inputs called “floating inputs”...
Page 74
Digital Input - connection example with a device with 24V output DI/DO PLUGIN CONFIGURATION The plugin “Digital input/output” allows you to define rules that control the behaviour of digital inputs/outputs on SMSEagle device. User may define several processing rules for both inputs and outputs. | SMSEagle NXS-9700 | User’s Manual...
Page 75
The recipient’s name from phonebook • Alert timeout. This value defines time between consecutive alerts. If the value is set and input is • triggered several times during the timeout, only one alert message will be sent | SMSEagle NXS-9700 | User’s Manual...
Page 76
SMS text contains given value) State of output signal that will be triggered by incoming SMS message • Output signal duration in seconds (0 = without time limit) • Output signal delay before signal is set • | SMSEagle NXS-9700 | User’s Manual...
±0.5°C accuracy and humidity with ±2% RH accuracy. Additionally, NXS-97xx Rev.3 (and higher) devices also support external sensors via 1-Wire interface. A measured values from sensors can be displayed in web-gui of SMSEagle and used to trigger SMS message to single/many recipients.
Page 78
• Sensor (internal or external) • On what condition SMS alarm should be sent (temperature/humidity is higher/lower than given • value) SMS text • SMS recipient: contact name or group name from Phonebook • | SMSEagle NXS-9700 | User’s Manual...
Page 79
(in minutes). If external sensors are supported they can be added and defined here. Screenshot from “Settings” window READING TEMP/HUMIDITY VIA SNMP PROTOCOL Current temperature and humidity values from internal sensor can be also read via SNMP protocol. See chapter “SNMP agent” for detailed description. | SMSEagle NXS-9700 | User’s Manual...
LDAP plugin The LDAP plugin allows to access Active Directory (hereinafter referred to as “AD”) and read contacts and groups in SMSEagle web-GUI. The plugin can work with either Active Directory or OpenLDAP protocol type. PLUGIN CONFIGURATION Choose “LDAP” from left side menu in SMSEagle web-GUI to access plugin configuration. After enabling the plugin, user needs to fill in all requested fields according to AD settings.
Page 81
Screenshot from “LDAP settings” window Click “Save” and “Test connection” to make sure that SMSEagle is connected with AD server. Screenshot showing successful connection to AD server. With connection established, AD contacts/groups suggestions are shown in selected modules of web-gui.
This feature allows you to add a number to a Blacklist. When a number is on this list, the device automatically blocks any sent and received SMS from the number as well as deletes the messages from your inbox. Screenshot from “Blacklist” feature | SMSEagle NXS-9700 | User’s Manual...
Page 83
Screenshot from Blacklist > Define STOP word feature You may defined a STOP keyword. When incoming message contains the keyword then the sender • number will be automatically added to blacklist. | SMSEagle NXS-9700 | User’s Manual...
SMSEAGLE API SMSEagle has powerful built-in REST API functionalities. API is dedicated for integration of SMSEagle with any external system or application. Below you will find a detailed description of API functionalities. SMSEagle API supports both HTTP and HTTPS protocol.
Page 85
– minute, SS – second) test (optional parameter) 1 = simulate message sending. Messages with that parameter will not be added to outbox and they will return ID = 0 EXAMPLES: https://url-of-smseagle/http_api/send_sms? access_token=0005gOjCOlMH8F2x&to=1234567&message=mymessage https://url-of-smseagle/http_api/send_sms? access_token=0005gOjCOlMH8F2x&to=1234567&message=mymessage&date=20140115213 | SMSEagle NXS-9700 | User’s Manual...
Page 86
<error_text>Invalid Access token</error_text> <status>error</status> </xml> Response (when wrong parameters): <xml> <error_text>Wrong parameters</error_text> <status>error</status> </xml> Important notice: You must encode URL before sending it to gateway if you use national characters in SMS message text. | SMSEagle NXS-9700 | User’s Manual...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle recipient telephone number (or numbers separated with comma) message...
SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle groupname group name defined in your SMSEagle Phonebook. The group must be defined as Public message your SMS message date (optional parameter) date and time in format YYYYmmDDHHMM (YYYY –...
SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle groupname group name defined in your SMSEagle Phonebook. The group must be defined as Public message your SMS message date (optional parameter) date and time in format YYYYmmDDHHMM (YYYY –...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contactname contact name (or names separated by comma) defined in your SMSEagle Phonebook.
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contactname contact name defined in your SMSEagle Phonebook. The contact must be...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle USSD code (urlencoded) modem_no (optional parameter) sending modem number (only for multimodem devices)
Page 98
<status>error</status> </xml> Response (when wrong parameters): <xml> <error_text>Wrong parameters</error_text> <status>error</status> </xml> Important notice: You must urlencode USSD code before sending it to gateway. Response from cellular network will show up in device Inbox folder. | SMSEagle NXS-9700 | User’s Manual...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle USSD code modem_no (optional parameter) sending modem number (only for multimodem devices)
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle recipient telephone number (or numbers separated with comma) (optional parameter) UDH header for the message (in hex format)
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle recipient telephone number (or numbers separated with comma) (optional parameter) UDH header for the message (in hex format)
Page 103
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems...
Page 107
<Coding>Default_No_Compression</Coding> <UDH></UDH> <SMSCNumber></SMSCNumber> <Class>-1</Class> <TextDecoded>Test with bad phone number</TextDecoded> <ID>578</ID> <SenderID>smseagle2</SenderID> <SequencePosition>1</SequencePosition> <Status>SendingError</Status> <StatusError>-1</StatusError> <TPMR>-1</TPMR> <RelativeValidity>255</RelativeValidity> <CreatorID>admin</CreatorID> <id_folder>3</id_folder> <StatusCode>21</StatusCode> </item> </messages> <status>ok</status> </xml> Response (when no data): <xml> <error_text>No data to display</error_text> <status>error</status> </xml> | SMSEagle NXS-9700 | User’s Manual...
Page 108
SMS unique identification number RecipientID text which modem received the message (for example: smseagle1, smseagle2) Processed boolean whether SMS was processed by SMSEagle application id_folder integer identification of storage folder. Possible values: Inbox Trash 11… Custom folder readed text...
Page 109
SMS unique identification number SenderID character varying (255) which modem sent the message (for example: smseagle1, smseagle2) SequencePosition integer SMS number in SMS sequence Status character varying (255) Status of message sending. Possible values: SendingOK | SMSEagle NXS-9700 | User’s Manual...
> -1 CMS Error occurred. CMS error number is saved in this field. 12. Read SMS/MMS: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/jsonrpc/sms Parameter Description access_token authentication access token (see details in point API Authentication) | SMSEagle NXS-9700 | User’s Manual...
Page 111
SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems idfrom (optional parameter) minimal message-id idto (optional parameter) maximum message-id from (optional parameter) telephone number of SMS sender (for inbox)
Page 121
SMS unique identification number RecipientID text which modem received the message (for example: smseagle1, smseagle2) Processed boolean whether SMS was processed by SMSEagle application id_folder integer identification of storage folder. Possible values: Inbox Trash 11… Custom folder readed text...
Page 122
SMS unique identification number SenderID character varying (255) which modem sent the message (for example: smseagle1, smseagle2) SequencePosition integer SMS number in SMS sequence Status character varying (255) Status of message sending. Possible values: SendingOK | SMSEagle NXS-9700 | User’s Manual...
Page 123
Field available when include_attachments parameter has been set to 1. Contains headers from MMS message. MMSReports text Field available when include_attachments parameter has been set to 1. Contains delivery report from MMSC for sent MMS messages. | SMSEagle NXS-9700 | User’s Manual...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems...
Description access_token authentication access token (see details in point API Authentication) Login your user to login to SMSEagle (see details in point API Authentication) Pass your password to login to SMSEagle Responsetype (optional parameter) text = format response as text (default), xml = format...
Description access_token authentication access token (see details in point API Authentication) Login your user to login to SMSEagle (see details in point API Authentication) Pass your password to login to SMSEagle Responsetype (optional parameter) simple = format response as simple object with one result...
Description access_token authentication access token (see details in point API Authentication) Login your user to login to SMSEagle (see details in point API Authentication) Pass your password to login to SMSEagle Responsetype (optional parameter) text = format response as text (default), xml = format...
HTTP POST METHOD: https://url-of-smseagle/jsonrpc/sms Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle | SMSEagle NXS-9700 | User’s Manual...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle responsetype (optional parameter) text = format response as text (default), xml = format...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle responsetype (optional parameter) simple = format response as simple object with one result...
Page 133
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle groupname name for the created group public...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle groupname name for the created group public...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle public (optional parameter) 0 = private group (default value), 1 = public group...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle public (optional parameter) 0 = private group (default value), 1 = public group...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group groupname name for the group...
Page 141
Response (when wrong parameters): <xml> <error_text>Wrong or missing >>groupname<< parameter</error_text> <status>error</status> </xml> <xml> <error_text>Wrong or missing >>group_id<< parameter</error_text> <status>error</status> </xml> Response (when group_id is wrong): <xml> <error_text>Group with the given id does not exists</error_text> <status>error</status> </xml> | SMSEagle NXS-9700 | User’s Manual...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group groupname name for the group...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group groupname name of existing group...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group groupname name of existing group...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact.
Page 146
Response (when wrong parameters): <xml> <error_text>Wrong or missing >>group_id<< parameter</error_text> <status>error</status> </xml> <xml> <error_text>Wrong or missing >>contact_id<< parameter</error_text> <status>error</status> </xml> Response (when id is wrong): <xml> <error_text>Group with the given id does not exists</error_text> <status>error</status> </xml> | SMSEagle NXS-9700 | User’s Manual...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact.
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact.
Page 149
<error_text>Wrong or missing >>contact_id<< parameter</error_text> <status>error</status> </xml> Response (when id is wrong): <xml> <error_text>Group with the given id does not exists</error_text> <status>error</status> </xml> <xml> <error_text>Contact with the given id does not exists</error_text> <status>error</status> </xml> | SMSEagle NXS-9700 | User’s Manual...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact.
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contactname name for the created contact number...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contactname name for the created contact number...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle public (optional parameter) 0 = private contacts (default value), 1 = public contacts...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle public (optional parameter) 0 = private contacts (default value), 1 = public contacts...
Page 156
{"result": "Wrong or missing >>public<< parameter"} RESPONSE (EXTENDED): Sample response: {"result":{"contacts":[ {"ID":"2","GroupID":"-1","Name":"John Doe","Number":"123123123","id_user":"1","is_public":"false"}, {"ID":"4","GroupID":"-1","Name":"Jan Nowak","Number":"4215456456","id_user":"1","is_public":"false"}, {"ID":"5","GroupID":"- 1","Name":"Andy","Number":"+441234155931","id_user":"1","is_public":"false" ],"status":"ok"}} Response (when no data): {"result": {"error_text":" No data to display","status":"error"}} Response (when wrong logindata): {"result": {"error_text":"Invalid login or password","status":"error"}} | SMSEagle NXS-9700 | User’s Manual...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name for the contact...
<xml> <error_text>Wrong or missing >>number<< parameter</error_text> <status>error</status> </xml> Response (when contact_id is wrong): <xml> <error_text>Contact with the given id does not exists</error_text> <status>error</status> </xml> 40. Phonebook contact update: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/jsonrpc/sms | SMSEagle NXS-9700 | User’s Manual...
Page 159
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name for the contact...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle phone numer to call duration connection duration (in seconds)
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle phone numer to call duration connection duration (in seconds)
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle name name for the created shift enabled...
HTTP POST METHOD: https://url-of-smseagle/jsonrpc/sms Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle | SMSEagle NXS-9700 | User’s Manual...
47. Phonebook shift read: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/http_api/shift_read Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) | SMSEagle NXS-9700 | User’s Manual...
Page 168
SMSEagle name (optional parameter) shift name enabled (optional parameter) 0 = disabled, 1 = enabled shift_id (optional parameter) shift id responsetype (optional parameter) text = format response as text (default), xml = format response as XML object...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle name (optional parameter) shift name enabled (optional parameter) 0 = disabled, 1 = enabled...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift name name for the shift...
Page 172
Response (when wrong parameters): <xml> <error_text>Wrong or missing >>name<< parameter</error_text> <status>error</status> </xml> <xml> <error_text>Wrong or missing >>shift_id<< parameter</error_text> <status>error</status> </xml> Response (when shift_id is wrong): <xml> <error_text>Shift with given id does not exists</error_text> <status>error</status> | SMSEagle NXS-9700 | User’s Manual...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift name name for the shift...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift responsetype (optional parameter) text = format response as text (default), xml = format...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift responsetype (optional parameter) simple = format response as simple object with one result...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) contact_id id of contact.
Page 177
<error_text>Wrong or missing >>contact_id<< parameter</error_text> <status>error</status> </xml> Response (when id is wrong): <xml> <error_text>Shift with the given id does not exists</error_text> <status>error</status> </xml> <xml> <error_text>Contact with the given id does not exists</error_text> <status>error</status> </xml> | SMSEagle NXS-9700 | User’s Manual...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) contact_id id of contact.
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) contact_id id of contact.
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) | SMSEagle NXS-9700 | User’s Manual...
Response (when id is wrong): {"result": {"error_text":"Shift with the given id does not exists","status":"error"}} {"result": {"error_text":"Contact with the given id does not exists","status":"error"}} 57. Get modem state: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/http_api/get_modem_state Parameter Description | SMSEagle NXS-9700 | User’s Manual...
Page 182
(see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no (optional parameter) modem number for status change (default = 1). Used only in...
Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no (optional parameter) modem number for status change (default = 1). Used only in...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle username username to be queried responsetype (optional parameter) text = format response as text (default), xml = format...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle username username to be queried responsetype (optional parameter) simple = format response as simple object with one result...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id ID of group to be queried user_id...
Page 190
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id ID of group to be queried user_id...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no modem number (default = 1) responsetype...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no modem number (default = 1) responsetype...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no modem number (default = 1) status status of call forwarding 0 = disabled, 1 = enabled...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
Page 198
Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
SMSEagle has a number of ready-to-use plugins and integration manuals for an easy and quick integration of SMSEagle device with external software (Network Monitoring Systems, Authentication Systems and other). The list grows constantly and is published on SMSEagle website. For a complete and up to date list of plugins please go to: https://www.smseagle.eu/integration-plugins/...
EXTRAS Delivery Reports SMSEagle software allows you to enable delivery reports for each sent SMS. Delivery reports is afeature that allows to receive a confirmation that SMS was received on recipients phone. In order to enable delivery reports, please go to web-GUI > menu Settings and set “Delivery Reports” to “Yes”...
Once database access isenabled, it is possible to connect to the database from external application using the following credentials: OSTGRE DATABASE CREDENTIALS Host: IP address of your device Database name: smseagle User: smseagleuser Password: postgreeagle Injecting short SMS using SQL The simplest example is short text message (limited to 160 chars):...
INSERT INTO outbox_multipart ( "ID", "SequencePosition", "UDH", "TextDecoded", "Coding", "Class" ) SELECT CURRVAL(pg_get_serial_sequence('outbox','ID')), '050003D30202', 's nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', 'Default_No_Compression', INSERT INTO user_outbox ( id_outbox, id_user ) SELECT | SMSEagle NXS-9700 | User’s Manual...
Page 203
CURRVAL(pg_get_serial_sequence('outbox','ID')), Note: Adding UDH means that you have less space for text, in above example you can use only 153 characters in single message. | SMSEagle NXS-9700 | User’s Manual...
1) Create a file inside /etc/cron.d/ directory with your desired name (eg. pico db_cleaner) 2) Example content of this file: 0 0 1 * * root /mnt/nand-user/scripts/db_delete_allfolders This will run cleaning script every 1 day of month. | SMSEagle NXS-9700 | User’s Manual...
It is used mostly in network management systems to monitor network-attached devices for conditions that warrant administrative attention” (source: Wikipedia). SMSEagle device has a built-in Net-SNMP agent. The SNMP agent provides access to Linux Host MIB tree of the device, and additionally (using extension NET-SNMP-EXTEND-MIB) allows access to custom metrics specific to SMSEagle.
Page 206
-v 2c -c public localhost .1.3.6.1.4.1.8072.1.3.2.3.1.2.11.71.83.77.95.83.105.103.110.97.108.49 Result: NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_Signal" = STRING: 54 Comment: GSM/3G/4G Signal strength value is 54% EXAMPLE OF READING GSM_NETNAME1 VALUE USING NET-SNMP LIBRARY a) Command for reading the result value: | SMSEagle NXS-9700 | User’s Manual...
Page 207
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (216622) 0:36:06.22 Comment: Linux system is up for 36 hours, 6.22 minutes EXAMPLE OF BROWSING SMSEAGLE EXTENSION PARAMETERS IN MIB TREE USING NET-SNMP LIBRARY a) Command for reading the result value: snmpwalk -v 2c -c public ip-of-smseagle .1.3.6.1.4.1.8072.1.3.2.3.1.2 Result: NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_Signal"...
EXAMPLE OF BROWSING SMSEAGLE EXTENSION PARAMETERS IN MIB TREE USING MIB-BROWSER Setting up SNMP v3 access control By default, SMSEagle devices uses SNMP v2 access control. Using v3 can strengthen security, however is not mandatory. To easily switch to SNMP v3 access control we’ve prepared special shell script located at /mnt/nand-user/smseagle directory.
PORT – port on receiving server PROTOCOL one of the values: tcp, udp Example: • *.* action(type="omfwd" target="192.168.0.250" port="10514" protocol="tcp" action.resumeRetryCount="10" queue.type="linkedList" queue.size="10000") • SSL-encryption of your log traffic: please have a look at this article: https://www.rsyslog.com/doc/v8-stable/tutorials/tls_cert_summary.html | SMSEagle NXS-9700 | User’s Manual...
(if the phone number is entered in the account) with a notification about new software update. Screenshot from “General settings-Maintenance” Notice: Your SMSEagle device must have a HTTPS connectivity with address www.smseagle.eu in order for this feature to work. | SMSEagle NXS-9700...
Knowledgebase & Support Portal More information and useful hints about SMSEagle device configuration can be found in our online knowledgebase and support portal at: https://support.smseagle.eu | SMSEagle NXS-9700 | User’s Manual...
Page 213
I I I TROUBLESHOOTING | SMSEagle NXS-9700 | User’s Manual...
In case of any problems with the device these logs are a valuable source of troubleshooting information. Extended device logs can be downloaded via button “Download device logs” in menu “Settings” > “Sysinfo”. | SMSEagle NXS-9700 | User’s Manual...
Restore service is counting button for 10 seconds down. System is reading factory 3. Release SW button defaults. after 10 seconds. User LED will begin to Factory settings are being blink. applied to the device. | SMSEagle NXS-9700 | User’s Manual...
Page 216
System is going for a reboot. reboots. Default settings are restored. Please note, that after reboot the device will be finishing the process of factory reset, therefore it can take longer for the system to start. | SMSEagle NXS-9700 | User’s Manual...
Go to menu Settings > Sysinfo > “Download device logs”. Provide log package to support team when requested. MAC address Each SMSEagle device has its unique MAC address. MAC address is printed on the device body or can be found in menu Settings > IP Settings | SMSEagle NXS-9700...
SAR regulation. DISCLAIMER: The manufacturer is not responsible for any damages caused by inappropriate installation, not maintaining the proper technical condition or using a product against its destination. | SMSEagle NXS-9700 | User’s Manual...
REGULATORY STATEMENTS EU Declaration of Conformity Hereby, Proximus Sp. z o.o., owner of SMSEagle brand, declares that the radio equipment type SMSEagle NXS-9700-3G, NXS-9700-4G is in compliance with Directive 2014/53/EU. The full text of the EU declaration of conformity is available at the following internet address: www.smseagle.eu/certification...
CAN ICES-3 (B)/NMB-3(B) UK Declaration of Conformity Hereby, Proximus Sp. z o.o., owner of SMSEagle brand, declares that the radio equipment type SMSEagle NXS-9700-3G, NXS-9700-4G is in compliance with The Radio Equipment Regulations 2017. The full text of the EU declaration of conformity is available at the following internet address: www.smseagle.eu/certification...
Disposal and Recycling Information Your SMSEagle device contains lithium battery for RTC backup. Dispose of the device and/or battery in accordance with local environmental laws and guidelines. European Union—Disposal Information The symbol above means that according to local laws and regulations your product shall be disposed of separately from household waste.
Restriction of Hazardous Substances Directive (RoHS) European Union RoHS SMSEagle devices sold in the European Union, on or after 3 January 2013 meet the requirements of Directive 2015/863 on the restriction of the use of certain hazardous substances in electrical and electronic equipment (“RoHS 3”).
Page 229
Proximus Sp. z o.o. Ul. Piątkowska 163, 60-650 Poznań, Poland l Europe T +48 61 6713 413 E hello@smseagle.eu www.smseagle.eu | SMSEagle NXS-9700 | User’s Manual...
Need help?
Do you have a question about the NXS-9700-3G and is the answer not in the manual?
Questions and answers