SMSEagle NXS-9750 User manual

Type
User manual
Page 1
Page 2
Document version: 3.2
The materials used in this publicaon are copyright and are not to be duplicated, copied, or used
without the prior consent of the copyright holder. Technical specicaons are subject to change
without prior noce being given.
Page 3
CONTENTS
1. GET READY TO START ...................................................................................................................... 6
What’s in The BOX ............................................................................................................................... 7
Prepare for first start ........................................................................................................................... 8
2. USING OF SMSEAGLE ..................................................................................................................... 13
Get to know with Connectors, Ports and LEDs .................................................................................. 14
Basic Operations ................................................................................................................................ 15
SMSEagle basic features .................................................................................................................... 15
Phonebook ........................................................................................................................................ 16
Phonebook Contacts ..................................................................................................................... 16
Phonebook Groups ........................................................................................................................ 16
Phonebook Working Shifts ............................................................................................................ 17
Reporting module .............................................................................................................................. 17
Statistics view ................................................................................................................................ 18
SMSEagle plugins ............................................................................................................................... 19
Autoreply plugin ............................................................................................................................ 19
Network Monitoring plugin ........................................................................................................... 20
Email to SMS plugin ....................................................................................................................... 24
Email to SMS Poller ....................................................................................................................... 26
SMS to Email plugin ....................................................................................................................... 28
Callback URL plugin ....................................................................................................................... 29
SMS Forward ................................................................................................................................. 31
Periodic SMS .................................................................................................................................. 32
Digital input/output ....................................................................................................................... 33
SMSEagle API ..................................................................................................................................... 36
1. Send SMS: HTTP GET method .................................................................................................... 36
2. Send SMS: JSONRPC method ..................................................................................................... 37
3. Send SMS to a group: HTTP GET method .................................................................................. 39
4. Send SMS to a group: JSONRPC method ................................................................................... 40
5. Send SMS to contact: HTTP GET method .................................................................................. 41
6. Send SMS to contact: JSONRPC method ................................................................................... 43
7. Send USSD code: HTTP GET method ......................................................................................... 44
8. Send USSD code: JSONRPC method .......................................................................................... 45
9. Send binary SMS: HTTP GET method......................................................................................... 46
Page 4
10. Send binary SMS: JSONRPC method ........................................................................................ 48
11. Read SMS: HTTP GET method ................................................................................................. 49
12. READ SMS: JSONRPC METHOD ................................................................................................ 51
13. Delete SMS: HTTP GET method ............................................................................................... 55
14. Delete SMS: JSONRPC method ................................................................................................ 56
15. Get outgoing queue length: HTTP GET method ...................................................................... 57
16. Get outgoing queue length: JSONRPC method ....................................................................... 58
17. Get inbox length: HTTP GET method ....................................................................................... 58
18. Get inbox length: JSONRPC method ........................................................................................ 59
19. Get sentitems length: HTTP GET method ................................................................................ 60
20. Get sentitems length: JSONRPC method ................................................................................. 61
21. Get GSM/3G signal strength: HTTP GET method ..................................................................... 62
22. Get GSM/3G signal strength: JSONRPC method ..................................................................... 63
23. Phonebook group create: HTTP GET method ......................................................................... 64
24. Phonebook group create: JSONRPC method ........................................................................... 65
25. Phonebook group read: HTTP GET method ............................................................................ 66
26. Phonebook group read: JSONRPC method ............................................................................. 67
27. Phonebook group update: HTTP GET method ........................................................................ 68
28. Phonebook group update: JSONRPC method ......................................................................... 69
29. Phonebook group delete: HTTP GET method ......................................................................... 70
30. Phonebook group delete: JSONRPC method ........................................................................... 72
31. Phonebook group add contact: HTTP GET method ................................................................. 73
32. Phonebook group add contact: JSONRPC method .................................................................. 74
33. Phonebook group remove contact: HTTP GET method........................................................... 75
34. Phonebook group remove contact: JSONRPC method ............................................................ 76
35. Phonebook contact create: HTTP GET method ....................................................................... 77
36. Phonebook contact create: JSONRPC method ........................................................................ 78
37. Phonebook contact read: HTTP GET method .......................................................................... 79
38. Phonebook contact read: JSONRPC method ........................................................................... 81
39. Phonebook contact update: HTTP GET method ...................................................................... 82
40. Phonebook contact update: JSONRPC method ....................................................................... 84
41. Phonebook contact delete: HTTP GET method ....................................................................... 85
42. Phonebook contact delete: JSONRPC method ........................................................................ 86
Plugins and integration manuals for NMS & Auth systems .............................................................. 88
Connecting directly to SMSEagle database ....................................................................................... 89
Page 5
Injecting short SMS using SQL ........................................................................................................... 89
Injecting long SMS using SQL ............................................................................................................. 90
Database cleaning scripts .................................................................................................................. 92
SNMP agent ....................................................................................................................................... 93
Setting up SNMP v3 access control ............................................................................................... 96
Forwarding logs to external server ................................................................................................... 97
Automatic software updates checks ................................................................................................. 98
3. TROUBLESHOOTING ...................................................................................................................... 99
Verification of LEDs ......................................................................................................................... 100
Checking the device logs ................................................................................................................. 100
When the device is not reachable ................................................................................................... 100
Restoring factory defaults ............................................................................................................... 101
4. SERVICE AND REPAIR ................................................................................................................... 102
Warranty ......................................................................................................................................... 103
Service ............................................................................................................................................. 103
5. TECH SPECS AND SAFETY INFORMATION .................................................................................... 104
Technical Specifications................................................................................................................... 105
Important Safety Information ......................................................................................................... 107
Page 6
1. GET READY TO START
Page 7
What’s in The BOX
Your SMSEagle box contains:
SMSEagle Hardware SMS Gateway
External omnidireconal 3.5dBi GSM antenna (with magnec foot)
AC/DC power supply (input voltage: 100-240V)
Warranty card
Page 8
Prepare for rst 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.
Step 1: Connect GSM antenna
Plug in GSM 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 boom
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 to 30V with 17W power.
In order to power the device simply plug in a connector from AC/DC adaptor into the device.
Page 9
Step 4: Congure IP sengs
Follow the steps below in order to the device rst me using Ethernet – with inial factory
sengs on the device.
SMSEAGLE DEFAULT NETWORK CONFIGURATION
The following conguraon is set on a device by default:
IP address: 192.168.0.101
Subnet Mask: 255.255.255.0
DHCP client: ON
a) CONNECT TO A PC
The computer (PC) must be in the same network subnet as the device. Taking into account
the factory sengs of the device (listed above), a computer must have following IP
conguraon:
IP address: 192.168.0.X
Subnet Mask: 255.255.255.0
where X is any value between 1-244 excluding 101
Examples of valid IP addresses are: 192.168.0.1 and 192.168.0.102
The current tutorial assumes you have factory sengs on the device. If you do not know what
current network sengs are you can restore device to the factory sengs (see the
Troubleshoong chapter).
Page 10
Example of computer IP conguraon in Windows:
b) VERIFY YOUR CONNECTION
Properly connected device should respond to the ping command.
Example of ping aer a proper connecon to PC
c) LOG IN TO SMSEAGLE
Page 11
Open an internet browser on your PC and go to the address: 192.168.0.101
SMSEAGLE DEFAULT USER IS:
Username: admin
Password: password
Login to applicaon with above username and password.
d) CONFIGURE IP SETTINGS
Click on menu posion “Sengsand navigate to tab “IP Sengs”.
Page 12
Enter your IP sengs. If you have DHCP server on your network you can choose “Get IP
address from DHCP– IP sengs will be obtained automacally.
Press “Savebuon.
e) SETTING SIM-CARD PIN NUMBER
This step should ONLY be done if your SIM-card requires PIN.
If your SIM-card requires PIN number at startup, go to Sengs > Maintenance Tab.
Enter your PIN number in the eld “SIM Card PIN”:
Press “Savebuon.
f) REBOOT THE DEVICE
Go to Sengs > Maintenance Tab. Press Reboot buon.
Page 13
2. USING OF SMSEAGLE
Page 14
Get to know with Connectors, Ports and LEDs
Element
Label
Descripon
Connector 1
C1
Power connector and serial ports
Connector 2
C2
Addional ports connector (not used)
SIM Card Slot
SIM
SIM card slot
SD Card Slot
SD
Slot for addional SD/MMC card
Ethernet Port
ETH
Ethernet RJ45 socket
Antenna
ANT
Antenna socket
Power LED
PWR
LED indicang power-on
User LED
USER
LED for user applicaon purpose (not used)
Ready LED
RDY
LED indicang device status
Reset
RST
Switch for reboong the device
User Switch
SW
Switch for restoring to factory sengs
Page 15
Basic Operaons
SMSEagle is capable to work in various screen resoluons, 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 First Start.
SMSEagle basic features
Sending & Receiving SMS (managing messages with Inbox, Outbox, Sent Items)
Smartphone-like conversaon 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 le
SMS Scheduling by specied date and me or delay
Message templates (save & edit your own templates)
Dierent message types (normal SMS, ash, WAP push, USSD codes)
Unicode support (support of naonal characters)
Muluser support (each user has access to a private Inbox, Outbox, Sent Items)
Page 16
Phonebook
Web-GUI of SMSEagle device is equipped with Phonebook for managing contacts, groups and shis. Each
user can create private and public contacts, gather contacts in private and public groups. Contacts can also
be oponally assigned to working shis. Contacts and groups from Phonebook allows users ecient
sending of messages.
Phonebook Contacts
Below we present a main Phonebook view, where user manages his Contacts.
Screenshot of default phonebook view
In Phonebook Contact Management users can:
Add/edit/delete contacts via web-gui
Import contacts from CSV le
Set contact to public or private visibility
Add contacts to groups
Add contacts to working shis
Send message to a contact
View message conversaon 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
Page 17
Phonebook Working Shis
The Shi management feature allows to assign Phonebook contacts to working shis. If a contact is
assigned to any working shi, before sending a message the device will check if the contact is on a
working shi. If the contact is not on shi the message will be skipped or moved to beginning of a next
shi. To start using working shis dene shis here and add contact to a shi in contact details.
Screenshot of shi management in phonebook
Reporng module
Reporng module is an extension of basic search feature. The module allows users to lter messages from
Inbox/Sent items folders based on custom criteria and display ltered messages. Filtered list of messages
can be exported to CSV le.
Screenshot of Reporng module
Page 18
Stascs view
The reporng module allows also to view daily stascs of sent/received messages. The stascs view
displays number of messages per day and sender/receiver number.
Screenshot of Stascs view in Reporng module
Page 19
SMSEagle plugins
Basic features of SMSEagle soware are extended by plugins that provide extra features to the soware.
Below you will nd a descripon of plugins available in each SMSEagle device. All plugins are an integral
part of SMSEagle soware. That means that all described plugins are installed in a standard soware of
SMSEagle device and are available for free.
Autoreply plugin
Plugin allows to automacally respond to each received message with dened text response.
PLUGIN CONFIGURATION
Plugin “Autoreplyallows 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:
o always,
o when incoming message contains defined text,
o when message sender belongs to Phonebook contact/group
If autoreply message text should be sent as Unicode characters
User may define many forwarding rules in the plugin
Each rule is processed independently
There is a possibility to enable/disable each rule
Plugin also allows to define sending limit for autoreply messages. It is possible to set limitation of max 5
messages / 10 minutes / phone number.
Page 20
Screenshot form “Add/edit autoreply rule
Network Monitoring plugin
SMSEagle is equipped with powerful (yet simple to use) network services monitoring features. With that
features you can monitor any service that has listening port open. SMSEagle is trying to connect to each
dened port in Network Monitoring feature and sends dened SMS alert when port is unavailable. Below
you will nd a brief overview of plugin capabilies.
  • Page 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24
  • Page 25 25
  • Page 26 26
  • Page 27 27
  • Page 28 28
  • Page 29 29
  • Page 30 30
  • Page 31 31
  • Page 32 32
  • Page 33 33
  • Page 34 34
  • Page 35 35
  • Page 36 36
  • Page 37 37
  • Page 38 38
  • Page 39 39
  • Page 40 40
  • Page 41 41
  • Page 42 42
  • Page 43 43
  • Page 44 44
  • Page 45 45
  • Page 46 46
  • Page 47 47
  • Page 48 48
  • Page 49 49
  • Page 50 50
  • Page 51 51
  • Page 52 52
  • Page 53 53
  • Page 54 54
  • Page 55 55
  • Page 56 56
  • Page 57 57
  • Page 58 58
  • Page 59 59
  • Page 60 60
  • Page 61 61
  • Page 62 62
  • Page 63 63
  • Page 64 64
  • Page 65 65
  • Page 66 66
  • Page 67 67
  • Page 68 68
  • Page 69 69
  • Page 70 70
  • Page 71 71
  • Page 72 72
  • Page 73 73
  • Page 74 74
  • Page 75 75
  • Page 76 76
  • Page 77 77
  • Page 78 78
  • Page 79 79
  • Page 80 80
  • Page 81 81
  • Page 82 82
  • Page 83 83
  • Page 84 84
  • Page 85 85
  • Page 86 86
  • Page 87 87
  • Page 88 88
  • Page 89 89
  • Page 90 90
  • Page 91 91
  • Page 92 92
  • Page 93 93
  • Page 94 94
  • Page 95 95
  • Page 96 96
  • Page 97 97
  • Page 98 98
  • Page 99 99
  • Page 100 100
  • Page 101 101
  • Page 102 102
  • Page 103 103
  • Page 104 104
  • Page 105 105
  • Page 106 106
  • Page 107 107

SMSEagle NXS-9750 User manual

Type
User manual

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI