SMSEagle NXS-9700 User manual

User’s Manual
SMSEAGLE
NXS-9700

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 are subject
Document version: 3.32
to change without prior notice being given.

CONTENTS
What’s In The Box ...................................................................................................................................................... 8
Prepare for First Start............................................................................................................................................... 9
Get to know with Connectors, Ports and LEDs................................................................................................14
Basic Operations ......................................................................................................................................................15
SMSEagle basic features........................................................................................................................................16
Phonebook.............................................................................................................................................................16
Phonebook Contacts......................................................................................................................................16
Phonebook Groups .........................................................................................................................................17
Phonebook Working Shifts...........................................................................................................................17
Reporting module................................................................................................................................................18
Statistics view..................................................................................................................................................18
SMSEagle plugins.....................................................................................................................................................19
Autoreply plugin...................................................................................................................................................19
Network Monitoring plugin...............................................................................................................................20
Email to SMS plugin ...........................................................................................................................................23
Email to SMS Poller.............................................................................................................................................26
SMS to Email plugin ...........................................................................................................................................28
Callback URL plugin ............................................................................................................................................30
SMS Forward ........................................................................................................................................................31
Periodic SMS.........................................................................................................................................................32
Digital input/output ...........................................................................................................................................33
Temperature & humidity sensor ....................................................................................................................36
LDAP plugin ..........................................................................................................................................................39
SMSEagle API............................................................................................................................................................41
1. Send SMS: HTTP GET method.....................................................................................................................41
2. Send SMS: JSONRPC method ......................................................................................................................43
3. Send SMS to a group: HTTP GET method ................................................................................................44
4. Send SMS to a group: JSONRPC method..................................................................................................46
5. Send SMS to contact: HTTP GET method ................................................................................................47

6. Send SMS to contact: JSONRPC method..................................................................................................49
7. Send USSD code: HTTP GET method.........................................................................................................50
8. Send USSD code: JSONRPC method..........................................................................................................52
9. Send binary SMS: HTTP GET method........................................................................................................52
10. Send binary SMS: JSONRPC method.......................................................................................................54
11. Read SMS: HTTP GET method..................................................................................................................55
12. Read SMS: JSONRPC method....................................................................................................................63
13. Delete SMS: HTTP GET method ...............................................................................................................74
14. Delete SMS: JSONRPC method.................................................................................................................75
15. Get outgoing queue length: HTTP GET method...................................................................................76
16. Get outgoing queue length: JSONRPC method ....................................................................................77
17. Get inbox length: HTTP GET method ......................................................................................................78
18. Get inbox length: JSONRPC method........................................................................................................79
19. Get sentitems length: HTTP GET method .............................................................................................80
20. Get sentitems length: JSONRPC method...............................................................................................81
21. Get GSM/3G signal strength: HTTP GET method................................................................................82
22. Get GSM/3G signal strength: JSONRPC method .................................................................................83
23. Phonebook group create: HTTP GET method.......................................................................................84
24. Phonebook group create: JSONRPC method........................................................................................85
25. Phonebook group read: HTTP GET method..........................................................................................86
26. Phonebook group read: JSONRPC method............................................................................................87
27. Phonebook group update: HTTP GET method .....................................................................................88
28. Phonebook group update: JSONRPC method.......................................................................................90
29. Phonebook group delete: HTTP GET method.......................................................................................91
30. Phonebook group delete: JSONRPC method ........................................................................................92
31. Phonebook group add contact: HTTP GET method.............................................................................93
32. Phonebook group add contact: JSONRPC method..............................................................................94
33. Phonebook group remove contact: HTTP GET method.....................................................................96
34. Phonebook group remove contact: JSONRPC method ......................................................................97
35. Phonebook contact create: HTTP GET method....................................................................................98

36. Phonebook contact create: JSONRPC method.....................................................................................99
37. Phonebook contact read: HTTP GET method .................................................................................... 100
38. Phonebook contact read: JSONRPC method...................................................................................... 102
39. Phonebook contact update: HTTP GET method ............................................................................... 104
40. Phonebook contact update: JSONRPC method................................................................................. 105
41. Phonebook contact delete: HTTP GET method................................................................................. 106
42. Phonebook contact delete: JSONRPC method .................................................................................. 107
43. Call with termination: HTTP GET method........................................................................................... 108
44. Call with termination: JSONRPC method ............................................................................................ 110
45. Phonebook shift create: HTTP GET method...................................................................................... 111
46. Phonebook shift create: JSONRPC method........................................................................................ 112
47. Phonebook shift read: HTTP GET method.......................................................................................... 113
48. Phonebook shift read: JSONRPC method........................................................................................... 115
49. Phonebook shift update: HTTP GET method..................................................................................... 117
50. Phonebook shift update: JSONRPC method ...................................................................................... 118
51. Phonebook shift delete: HTTP GET method ...................................................................................... 119
52. Phonebook shift delete: JSONRPC method........................................................................................ 120
53. Phonebook shift add contact: HTTP GET method............................................................................ 121
54. Phonebook shift add contact: JSONRPC method ............................................................................. 122
55. Phonebook shift remove contact: HTTP GET method .................................................................... 124
56. Phonebook shift remove contact: JSONRPC method...................................................................... 125
57. Get modem state: HTTP GET method.................................................................................................. 126
58. Get modem state: JSONRPC method................................................................................................... 127
59. Set modem state: HTTP GET method.................................................................................................. 128
60. Set modem state: JSONRPC method................................................................................................... 129
61. User ID read: HTTP GET method ........................................................................................................... 130
62. User ID read: JSONRPC method............................................................................................................. 131
63. Group members read: HTTP GET method .......................................................................................... 132
64. Group members read: JSONRPC method............................................................................................ 133
Plugins and integration manuals for NMS & Auth systems ..................................................................... 136

Extras........................................................................................................................................................................ 137
Connecting directly to SMSEagle SQL database .................................................................................... 137
Injecting short SMS using SQL .................................................................................................................... 137
Injecting long SMS using SQL ...................................................................................................................... 138
Database cleaning scripts .............................................................................................................................. 140
SNMP agent ....................................................................................................................................................... 141
Setting up SNMP v3 access control........................................................................................................ 144
Failover (HA-cluster) feature ........................................................................................................................ 146
Forwarding logs to external server.............................................................................................................. 149
Automatic software updates checks .......................................................................................................... 150
Troubleshooting..................................................................................................................................................... 152
Verification of LEDs.......................................................................................................................................... 152
Checking the device logs................................................................................................................................. 152
When the device is not reachable................................................................................................................ 152
Restoring factory defaults ............................................................................................................................. 153
Service & Repair..................................................................................................................................................... 156
Warranty ............................................................................................................................................................ 156
Service ................................................................................................................................................................. 156
Tech Specs & Safety Information ..................................................................................................................... 158
Technical Specification.................................................................................................................................... 158
Important Safety Information ...................................................................................................................... 160
Regulatory Statements ....................................................................................................................................... 161
FCC compliance statement ........................................................................................................................... 161
Canadian regulatory statement ................................................................................................................... 161
Disposal and recycling information ............................................................................................................. 162
Restriction of Hazardous Substances Directive (RoHS) ........................................................................ 162

7 | SMSEagle NXS-9700-3G | User’s Manual
GET READY
TO START
I

8 | SMSEagle NXS-9700-3G | User’s Manual
WHAT’S IN THE BOX
Your SMSEagle box contains:
•SMSEagle hardware SMS gateway
•External omnidirectional 3dBi GSM/3G antenna (with magnetic foot)
•AC/DC power supply (input voltage: 100-240V)
•Warranty card

9 | SMSEagle NXS-9700-3G | User’s Manual
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.
STEP 1: Install GSM/3G antenna
ANTENNA INSTALLATION GUIDELINES
•Install the antenna in a location with access to a cellular network radio signal.
•The antenna must be installed such that it provides a separation distance of at least 20 cm from all
persons and must not be co-located or operating in conjunction with any other antenna or
transmitter.
•The antenna must not be installed inside metal cases.
Plug in 3G antenna connector to the device.
STEP 2: Insert SIM Card
Please install SIM Card when the device is SWITCHED OFF. SIM Card slot is located at the bottom of the
device. Use a ball-pen or small screwdriver to eject SIM Card tray. Insert card into tray and push it gently into
slot.
STEP 3: Power the device
The device is powered with AC/DC power supply adaptor delivered in the box. The device needs a power
source of 12V DC / 1A. In order to power the device simply plug in a connector from AC/DC adaptor into the
device.
PREPARE FOR FIRST START

10 | SMSEagle NXS-9700-3G | User’s Manual
PREPARE FOR FIRST START
STEP 4: Configure IP settings
A) 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
•read assigned IP address on your DHCP server
B) OR SET IP ADDRESS FOR SMSEAGLE MANUALLY
•connect a display using HDMI connector, connect a keyboard to USB port (note: cables are not
provided)
•login to the SSH console using root credentials (these were provided with your device)
•edit configuration file with command:
mcedit /mnt/nand-user/smseagle/syscfg
change the following lines:
HOST_IP= (set IP address for your device)
GW_IP= (default gateway IP address)
NET_MASK= (set subnet mask)
START_DHCP=Y (set to START_DHCP=N to disable DHCP client)
•save and exit the file
•shutdown the device
•now connect SMSEagle to your LAN using Ethernet cable
SMSEAGLE DEFAULT NETWORK CONFIGURATION:
DHCP CLIENT IS ON
(IP ADDRESS WILL BE OBTAINED AUTOMATICALLY FROM YOUR DHCP SERVER)

11 | SMSEagle NXS-9700-3G | User’s Manual
PREPARE FOR FIRST START
C) LOG IN TO SMSEAGLE
Open an internet browser on your PC and go to the IP address assigned to your gateway
SMSEAGLE DEFAULT USER:
Login to application with above username and password.
D) CONFIGURE STATIC IP SETTINGS IN WEB-GUI (OPTIONAL)
Click on menu position “Settings” and navigate to tab “IP Settings”.
Disable DHCP server. Enter your IP settings. > Press “Save” button.
Username: admin
Password: password

12 | SMSEagle NXS-9700-3G | User’s Manual
PREPARE FOR FIRST START
STEP 5: Setting SIM Card PIN
This step should ONLY be done if your SIM-card requires PIN.
If your SIM-card requires PIN number at startup, go to Settings > Maintenance Tab.
Enter your PIN number in the field “SIM Card PIN”
STEP 6: Reboot the device
Go to Settings > Maintenance Tab. Press Reboot button.
> Press “Save” button.

13 | SMSEagle NXS-9700-3G | User’s Manual
USING OF
SMSEAGLE
II

14 | SMSEagle NXS-9700-3G | User’s Manual
GET TO KNOW WITH CONNECTORS, PORTS AND LEDS
Element
Label
Description
Connector 1
C1
Power connector and serial ports
SIM Card Slot
SIM1, SIM2 (optional)
SIM card slot(s)
HDMI port
HDMI
HDMI port (cable not included)
USB port
USB
USB port (cable not included)
Ethernet Port
ETH
Ethernet RJ45 socket
Antenna
ANT
Antenna socket
Power LED
PWR
LED indicating power-on
User LED
USER
LED for user application purpose (not used)
SIM1,2 LEDs
3G modem 1,
3G modem 2 (optional)
LED indicator for modem status
Ready LED
RDY
LED indication device status
Reset
RST
Switch for rebooting the device
User Switch
SW
Switch for restoring to factory settings

15 | SMSEagle NXS-9700-3G | User’s Manual
BASIC OPERATIONS
SMSEagle is capable to work in 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.

16 | SMSEagle NXS-9700-3G | User’s Manual
SMSEAGLE BASIC FEATURES
•Sending & Receiving SMS (managing messages with Inbox, Outbox, Sent Items)
•Smartphone-like conversation mode (messages are nicely grouped by phone number). You can
easily track history of what you send and receive
•Sending to single numbers, contacts or groups from phonebook
•Import messages for sending from CSV file
•SMS Scheduling by specified date and time or delay
•Message templates (save & edit your own templates)
•Different message types (normal SMS, flash, WAP push, USSD codes)
•Unicode support (support of national characters)
•Multiuser support (each user has access to a private Inbox, Outbox, Sent Items)
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.
Phonebook Contacts
Below we present a main Phonebook view, where user manages his Contacts.
Screenshot of default phonebook view

17 | SMSEagle NXS-9700-3G | User’s Manual
In Phonebook Contact Management users can:
•Add/edit/delete contacts via web-gui
•Import contacts from CSV file
•Set contact to public or private visibility
•Add contacts to groups
•Add contacts to working shifts
•Send message to a contact
•View message conversation of a contact
Phonebook Groups
Screenshot taken from phonebook groups
In Phonebook Group Management view users can:
•Add/edit/delete groups
•Set groups to public or private visbility
•View group content (contacts beloning to the group)
•Send message to a group
Phonebook Working Shifts
The Shift management feature allows to assign Phonebook contacts to work in shifts. If a contact is
assigned to any working shift, before sending a message the device will check if the contact is on a working
shift. If the contact is not on shift the message will be skipped or moved to beginning of a next shift. To start
using working shifts define shifts here and add contact to a shift in contact details.
Screenshot of shift management in phonebook

18 | SMSEagle NXS-9700-3G | User’s Manual
Reporting module
Reporting module is an extension of basic search feature. The module allows users to filter messages from
Inbox/Sent items folders based on custom criteria and display filtered messages. Filtered list of messages
can be exported to PDF or CSV file.
Screenshot of Reporting module
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

19 | SMSEagle NXS-9700-3G | User’s Manual
SMSEAGLE PLUGINS
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.
Autoreply plugin
Plugin allows to automatically respond to each received message with defined text response.
PLUGIN CONFIGURATION
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:
oalways,
owhen incoming message contains defined text,
oand/or when message sender belongs to Phonebook contact/group
•If autoreply message text should be sent as Unicode characters
Plugin also allows to define sending limit for autoreply messages. It is possible to set limitation of max 5
messages / 10 minutes / phone number.

20 | SMSEagle NXS-9700-3G | User’s Manual
Screenshot form “Add/edit autoreply rule”
Network Monitoring plugin
SMSEagle is equipped with network monitoring features. With that features you can monitor any device or
service that has listening port open. SMSEagle Network Monitoring plugin sequentially controls availability
of defined hosts/ports in Network Monitoring feature and sends defined SMS alert when port is
unavailable/goes back to life. Below you will find a brief overview of plugin capabilities.