SMSEAGLE

NXS-9750-3G
NXS-9750-4G

User’s Manual
 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
to change without prior notice being given. Document version: 3.51
CONTENTS
What’s In The Box ...................................................................................................................................................... 9

Prepare for First Start ............................................................................................................................................. 10

Get to know with Connectors, Ports and LEDs ................................................................................................ 15

Basic Operations....................................................................................................................................................... 16

SMSEagle basic features........................................................................................................................................ 17

Compose SMS....................................................................................................................................................... 17

Folders .................................................................................................................................................................... 18

Phonebook............................................................................................................................................................. 19

Phonebook Contacts ...................................................................................................................................... 19

Phonebook Groups ......................................................................................................................................... 20

Phonebook Working Shifts........................................................................................................................... 20

Reporting module ................................................................................................................................................ 20

Statistics view .................................................................................................................................................. 21

Settings .................................................................................................................................................................. 21

Application settings ........................................................................................................................................ 22

SMSEagle plugins ..................................................................................................................................................... 24

Autoreply plugin ................................................................................................................................................... 24

Network Monitoring plugin ............................................................................................................................... 25

Email to SMS plugin ........................................................................................................................................... 28

Email to SMS Poller............................................................................................................................................. 30

SMS to Email plugin ........................................................................................................................................... 33

Callback URL plugin ............................................................................................................................................ 34

SMS Forward ........................................................................................................................................................ 36

Periodic SMS ......................................................................................................................................................... 37

Digital input/output ........................................................................................................................................... 38

Temperature & humidity sensor .................................................................................................................... 43

LDAP plugin .......................................................................................................................................................... 46

Blacklist .................................................................................................................................................................. 47

Multimodem features ............................................................................................................................................. 48

SMSEagle API ............................................................................................................................................................ 49

0. API Authentication .......................................................................................................................................... 49

1. Send SMS: HTTP GET method ..................................................................................................................... 49

2. Send SMS: JSONRPC method ...................................................................................................................... 52

3. Send SMS to a group: HTTP GET method ................................................................................................ 53

4. Send SMS to a group: JSONRPC method .................................................................................................. 55

5. Send SMS to contact: HTTP GET method ................................................................................................ 57

6. Send SMS to contact: JSONRPC method .................................................................................................. 59

7. Send USSD code: HTTP GET method ......................................................................................................... 61

8. Send USSD code: JSONRPC method .......................................................................................................... 62

9. Send binary SMS: HTTP GET method ........................................................................................................ 63

10. Send binary SMS: JSONRPC method ....................................................................................................... 65

11. Read SMS: HTTP GET method .................................................................................................................. 66

12. Read SMS: JSONRPC method.................................................................................................................... 74

13. Delete SMS: HTTP GET method ............................................................................................................... 85

14. Delete SMS: JSONRPC method ................................................................................................................. 87

15. Get outgoing queue length: HTTP GET method ................................................................................... 88

16. Get outgoing queue length: JSONRPC method .................................................................................... 89

17. Get inbox length: HTTP GET method ...................................................................................................... 90

18. Get inbox length: JSONRPC method ........................................................................................................ 91

19. Get sentitems length: HTTP GET method ............................................................................................. 92

20. Get sentitems length: JSONRPC method ............................................................................................... 93

21. Get GSM/3G signal strength: HTTP GET method ................................................................................ 94

22. Get GSM/3G signal strength: JSONRPC method ................................................................................. 96

23. Phonebook group create: HTTP GET method ....................................................................................... 97

24. Phonebook group create: JSONRPC method ........................................................................................ 98

25. Phonebook group read: HTTP GET method .......................................................................................... 99

26. Phonebook group read: JSONRPC method ......................................................................................... 101

27. Phonebook group update: HTTP GET method .................................................................................. 102

28. Phonebook group update: JSONRPC method .................................................................................... 103

29. Phonebook group delete: HTTP GET method .................................................................................... 104

30. Phonebook group delete: JSONRPC method ..................................................................................... 106

31. Phonebook group add contact: HTTP GET method.......................................................................... 107

32. Phonebook group add contact: JSONRPC method ........................................................................... 109

33. Phonebook group remove contact: HTTP GET method .................................................................. 110

34. Phonebook group remove contact: JSONRPC method ................................................................... 111

35. Phonebook contact create: HTTP GET method ................................................................................. 112

36. Phonebook contact create: JSONRPC method .................................................................................. 114

37. Phonebook contact read: HTTP GET method .................................................................................... 115

38. Phonebook contact read: JSONRPC method ...................................................................................... 117

39. Phonebook contact update: HTTP GET method ............................................................................... 119

40. Phonebook contact update: JSONRPC method ................................................................................. 120

41. Phonebook contact delete: HTTP GET method ................................................................................. 121

42. Phonebook contact delete: JSONRPC method .................................................................................. 123

43. Call with termination: HTTP GET method ........................................................................................... 124

44. Call with termination: JSONRPC method............................................................................................. 126

45. Phonebook shift create: HTTP GET method ...................................................................................... 127

46. Phonebook shift create: JSONRPC method ........................................................................................ 128

47. Phonebook shift read: HTTP GET method .......................................................................................... 129

48. Phonebook shift read: JSONRPC method ........................................................................................... 131

49. Phonebook shift update: HTTP GET method ..................................................................................... 133

50. Phonebook shift update: JSONRPC method ...................................................................................... 134

51. Phonebook shift delete: HTTP GET method ...................................................................................... 136

52. Phonebook shift delete: JSONRPC method ........................................................................................ 137

53. Phonebook shift add contact: HTTP GET method ............................................................................ 138

54. Phonebook shift add contact: JSONRPC method.............................................................................. 139

55. Phonebook shift remove contact: HTTP GET method..................................................................... 141

56. Phonebook shift remove contact: JSONRPC method ...................................................................... 142

57. Get modem state: HTTP GET method .................................................................................................. 143

58. Get modem state: JSONRPC method ................................................................................................... 145

 59. Set modem state: HTTP GET method .................................................................................................. 146

60. Set modem state: JSONRPC method ................................................................................................... 147

61. User ID read: HTTP GET method ........................................................................................................... 148

62. User ID read: JSONRPC method............................................................................................................. 149

63. Group members read: HTTP GET method .......................................................................................... 150

64. Group members read: JSONRPC method............................................................................................ 151

Plugins and integration manuals for NMS & Auth systems ..................................................................... 154

Extras ........................................................................................................................................................................ 155

Connecting directly to SMSEagle database ............................................................................................ 155

Injecting short SMS using SQL .................................................................................................................... 155

Injecting long SMS using SQL ...................................................................................................................... 156

Database cleaning scripts .............................................................................................................................. 158

SNMP agent ....................................................................................................................................................... 159

Setting up SNMP v3 access control ........................................................................................................ 162

Failover (HA-cluster) feature ........................................................................................................................ 164

Forwarding logs to external server.............................................................................................................. 167

Automatic software updates checks .......................................................................................................... 168

Troubleshooting..................................................................................................................................................... 170

Verification of LEDs .......................................................................................................................................... 170

Checking the device information .................................................................................................................. 170

Device logs.......................................................................................................................................................... 170

When the device is not reachable ................................................................................................................ 171

Restoring factory defaults ............................................................................................................................. 171

Service & Repair..................................................................................................................................................... 174

Warranty ............................................................................................................................................................ 174

Service ................................................................................................................................................................. 174

Tech Specs & Safety Information ..................................................................................................................... 176

Technical Specification .................................................................................................................................... 176

Important Safety Information ...................................................................................................................... 179

Regulatory Statements ....................................................................................................................................... 180

EU declaration of conformity ........................................................................................................................ 180

FCC compliance statement ............................................................................................................................ 180

Canadian regulatory statement ................................................................................................................... 181

Disposal and recycling information ............................................................................................................. 181

Restriction of Hazardous Substances Directive (RoHS) ........................................................................ 181

 I TO START
GET READY

8 | SMSEagle NXS-9700-3G | User’s Manual

WHAT’S IN THE BOX

Your SMSEagle box contains:

• SMSEagle hardware SMS gateway
• 2x External omnidirectional antenna (with magnetic foot)
• AC/DC power supply (input voltage: 100-240V)
• Warranty card

9 | SMSEagle NXS-9750 | 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.

STEP 1: Install 3G/4G antennas

ANTENNA INSTALLATION GUIDELINES

• Install antennas in a location with access to a cellular network radio signal.
• Antennas 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.
• Antennas must not be installed inside metal cases.
• Make sure the SMSEagle antennas are placed at least 20cm (8 inches) from each other.

Plug in both antenna connectors to the SMSEagle device.

STEP 2: Insert SIM Card

Please install SIM Card when the device is SWITCHED OFF. SIM Card slots 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.

10 | SMSEagle NXS-9750 | User’s Manual

PREPARE FOR FIRST START

STEP 4: Configure IP settings

SMSEAGLE DEFAULT NETWORK CONFIGURATION:

DHCP CLIENT IS ON

(IP ADDRESS WILL BE OBTAINED AUTOMATICALLY FROM YOUR DHCP SERVER)

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

11 | SMSEagle NXS-9750 | 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:

Username: admin

Password: password

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.

12 | SMSEagle NXS-9750 | 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”

> Press “Save” button.

STEP 6: Installing custom SSL certificate and HTTPS-only (OPTIONAL)

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 this knowledgebase article.

Installing your own SSL certificate

SMSEagle device comes with a self-signed SSL certificate. You may install your own SSL certificate or a free
Let’s Encrypt SSL certificate by following these knowledgebase articles.

STEP 7: Reboot the device

Go to Settings > Maintenance Tab. Press Reboot button.

13 | SMSEagle NXS-9750 | User’s Manual

 II SMSEAGLE
USING OF

14 | SMSEagle NXS-9750 | User’s Manual

GET TO KNOW WITH CONNECTORS, PORTS AND LEDS

Element Label Description

VCC (Rev.3 only) VCC Power connector

12-pole connector Hardware Rev.3: 4x digital Input, 4x digital

output, 1x 1Wire, 1x 5V, 2x GND
Hardware Rev. 2, Rev.1: Power connector, 2x
digital input, 2x digital output, 2x serial port, 2x
GND

SIM Card Slot SIM1, SIM2 SIM card slots

HDMI port HDMI HDMI port (for debugging purposes only)

USB port USB USB port

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 Modem 1,2 (optional) LED indicator for modem status (only in 3G
devices)

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-9750 | User’s Manual

BASIC OPERATIONS

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.

16 | SMSEagle NXS-9750 | 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)

Compose SMS

Here we show the various ways of sending an SMS form your device.

Screenshot of default Compose SMS view

17 | SMSEagle NXS-9750 | User’s Manual

In Compose SMS users can:

• Send SMS to contact from phonebook, input manually or import from file
• When importing from file each column can be used as a placeholder in the message. During sending
the placeholder will be replaced by a unique value for each imported row from CSV file.
• Set send date to now, at a date and time, after a delay, or between selected hours
• Set duration validity of SMS
• Type of SMS, normal, flash, WAP Push Link or USSD Code
• Set a message template to be saved and used at another time
• Send as Unicode (for special character use)
• Send message or Send and Repeat (window remains open, allowing modifications to next message)

Folders

Folders contain your messages. They are conveniently grouped into 5 categories:

• Inbox
• Outbox
• Sent Items
• Spam
• Trash

The view of conversations can be either of type “Baloons” (smartphone like conversation) or “Table” (tabular
view). The view type can be changed in menu Settings > Application.

Baloons view type:

18 | SMSEagle NXS-9750 | User’s Manual

Table view type:

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

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

Public contacts are visible to all users on the device while private contacts are visible to single user.

19 | SMSEagle NXS-9750 | User’s Manual

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

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.

20 | SMSEagle NXS-9750 | User’s Manual

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

Settings

Settings menu is divided into several tabs for easier maintenance.

21 | SMSEagle NXS-9750 | User’s Manual

Application settings
Application settings can be changed under the Settings Tab > Application.

• You can change the language of the application to English, French, German, Polish or Spanish
• You can change the country dial code to your country (this setting affects only correct assignment
of phone numbers to phonebook entries)
• You can sort the conversation to show messages either “Newest First” or “Oldest First”
• You can change the conversation view to either “Table” (tabular vier) or “Balloons” (smartphone-like
view), as shown in Folders chapter
• You can adjust the amount of data displayed on one page to 10, 15, 20, 25, 50, 100, 250 or Show all
• You can set for the messages to be permenantly deleted or be moved to Trash first
• You can set the receiving of delivery reports to Yes, No or Default (network carrier setting)
• You can set the visibility of the Inbox content to All users or Only admins
• You can set access of the reporting module to All users or Only admins
• You can enable the autoresponder for incoming MMS messages

22 | SMSEagle NXS-9750 | User’s Manual

 • You can set the MMS autoresponder message
• You can set a delay between SMS sending in seconds (this setting may be useful for cases where
cellular operator blocks a number due to intensive traffic. Note: setting delay between SMS sending
also introduces a delay time between receiving SMS)

23 | SMSEagle NXS-9750 | 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:

o always,
o when incoming message contains defined text,
o and/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.

24 | SMSEagle NXS-9750 | 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 operates ICMP, TCP, UDP or SNMP protocol. SMSEagle Network Monitoring plugin sequentially
controls availability of defined hosts/services in Network Monitoring feature and sends defined SMS alert
when host/service is unavailable/goes back to life or when SNMP return value reaches required criteria.
Below you will find a brief overview of plugin capabilities.

Control status of all your defined tasks

25 | SMSEagle NXS-9750 | User’s Manual

 • see a settings’ overview for all of your tasks
• check which server/service is currently unavailable
• see when a specific server/service was last down (last downtime)
• check what happened at last downtime (see server/service response)
• edit/delete your tasks
• disable tasks when needed (e.g. when doing a machine upgrades)

Define what you want to monitor in each task

• choose a name for the task

• set parent task. If parent task is defined, network monitor will monitor child task health only if
parent task is healthy
• enter a host (IP address or Hostname)
• choose 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)
• increase a default timeout value for busy servers (by default we set it to 30 seconds)
• test the connection of server

Define a schedule

26 | SMSEagle NXS-9750 | User’s Manual

 • choose if task should be always enabled…
• …or disable it at chosen times
(during a night, when a machine goes through planned restarts, during resource intensive backups,
etc.)
• enter a phone number or choose a group of users to send your SMS alert to
• select when to send SMS alert (when host/service goes down, when host/service goes up after
failure)

Define a SMS alert message

Define your SMS messages when host or service becomes unavailable/comes back to life. Choose field
placeholders for your SMS text:

• {TASKNAME} – puts a taskname inside SMS text

• {HOST} – hostname or IP address
• {RESPONSE} – message received (in case of no response from server/service)
• {TIMESTAMP} – timestamp of an error

Receive SMS alerts

• be alerted when your services/servers go down (or go up after failure)

• give yourself a chance to react quickly

27 | SMSEagle NXS-9750 | User’s Manual

 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.
You can manually increase/decrease monitoring period in Network Monitor settings:

If monitoring period value is too small (there are too many monitoring tasks to perform in parallel), the
software will adjust the value to ensure optimal workload and performance of your device.

REPORTS
This tab allows you to view reports of task errors in the Network Monitor for a selected period of time.

Screenshot from Network Monitor > Reports window.

Email to SMS plugin

Email to SMS plugin allows you to convert an email to SMS message.

BASIC USAGE
If the plugin is enabled, email sent to the email address:
PHONE_NUMBER@IP_ADDRESS_OF_SMSEAGLE will be converted to SMS message.

PHONE_NUMBER is a destination phone number

IP_ADDRESS_OF_SMSEAGLE is the IP address of your device.
The text of the email is the text of the SMS message (optionally you can append email subject at the
beginning of SMS message).

28 | SMSEagle NXS-9750 | User’s Manual

Example: email message sent to the address: [email protected] will be converted to SMS
message and delivered to phone number 123456789.

SEND TO USERNAME/GROUP
Email sent to the email address:
NAME_IN_PHONEBOOK@IP_ADDRESS_OF_SMSEAGLE will be converted to SMS message and will be
sent to a user or users’ group from SMSEagle’s phonebook.

NAME_IN_PHONEBOOK is a username or group name (must be a public group) from SMSEagle’s

phonebook
IP_ADDRESS_OF_SMSEAGLE is the IP address of your device.
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: [email protected] will be converted to SMS
message and delivered to all members of db-admin group. The db-admin group must be defined in your
SMSEagle phonebook.

USING FQDN IN EMAIL ADDRESS

It is also possible to use Fully Qualified Domain Name in an email address sent to SMSEagle box (eg.:
[email protected]). Please refer to our FAQ article: How do I configure Email2SMS plugin to
accept FQDN email addresses for more details.

EMAIL SUBJECT - ADDITIONAL PARAMETERS (OPTIONAL)

It is possible to set additional flags for single converted message using email subject. Currently the
following flags are available:
• date - date and time in format YYYYmmDDHHMM (YYYY – year, mm – month, DD – day, HH –
hour, MM – minute). If this parameter is not null SMS will be scheduled for sending at the given
date and time
• modem_no - sets sending modem number (available only for multimodem devices)

If you send email with subject containing FLAG=VALUE the flag will be set for this particular
email2SMS message.
Example 1: email message with subject containing modem_no=2 will be converted to SMS message and
sent via modem number 2.
Example 2: email message with subject containing date=201801010005&modem_no=2 will be converted
to SMS message and sent on 2018-01-01 00:05 via modem number 2.

29 | SMSEagle NXS-9750 | User’s Manual

PLUGIN CONFIGURATION

Screenshot from Email to SMS settings

• if you want to use the plugin, set ‘Email2SMS active’ to ‘Yes’

• if you want to include a subject of an email in SMS message, set ‘What to do with email subject’
setting to ‘Include in SMS’. The email subject will be appended at the beginning of SMS message
• if you want to use user authentication, set ‘What to do with email subject’ setting to ‘Use for
authentication’. If user authentication is enabled, provide in a subject of an email your login and
password in the following form: login=john&pass=doe OR provide API access token in the following
form: access_token=token
• if you want to include only a subject of an email in SMS message, set ‘What to do with email
subject’ setting to ‘Send only subject without email body’. Only the email subject will be inserted in
the SMS message
• the text of an email will be cropped to the value ‘Maximum number of characters. Maximum
allowed length of SMS message is 1300 characters
• if you want to include in SMS message special national characters (like ąäàöß 我) set “Unicode
encoding of SMS text” to ‘Yes’

Email to SMS Poller

30 | SMSEagle NXS-9750 | User’s Manual

Email2SMS Poller is an alternative for Email2SMS plugin for converting emails to SMS messages. This
plugin should be used when you need to fetch emails from an existing mailbox on your mail server. The
Email2SMS Poller plugin connects to a configured email account and polls it in specified periods of time for
new emails. Once a new email is received, it is automatically converted to an SMS message.

The plugin supports POP3 and IMAP accounts.

To send an SMS using Email2SMS Poller you have to send an email to a specified email account, with the
email subject containing a mobile number (or multiple phone numbers separated with comma) or
phonebook contact/group name.

BASIC EXAMPLE
For example, such email message:

TO: [email protected]
FROM: [email protected]
SUBJECT: +48333444555
BODY: Hello world!

In this case SMSEagle gateway will fetch an incoming email from [email protected] account and
send its body as 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. Marking a read message in the mailbox as unread
will result in being processed again by Email2SMS Poller. We suggest using a separate email account to
avoid situation with resending the same message (marking unread already processed read message).

31 | SMSEagle NXS-9750 | User’s Manual

PLUGIN CONFIGURATION

Screenshot from Email to SMS Poller

• if you want to use the plugin, set ‘Enable Email2SMS Poller’ to ‘Yes’
• Set email fetching interval (in seconds)
• the text of an email will be cropped to the value ‘Maximum number of characters. Maximum
allowed length of SMS message is 1300 characters.
• If you want to include special national characters, enable "Unicode encoding of SMS text"
• Choose protocol from IMAP or POP3
• Provide mailbox configuration (host, port, user, password, encryption settings)
• If you want to delete emails from the mailbox after they are fetched by Email2SMS Poller, please
mark "Delete emails from server after processing"

32 | SMSEagle NXS-9750 | User’s Manual

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:

a. forwarding of incoming 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. If no last sender is found, then the incoming message is
forwarded to a default email address given in plugin settings.

b. It forwards all the incoming messages to one fixed email address.

In this mode all incoming SMS messages are forwarded to always the same email address.

Plugin uses an external SMTP server for sending emails.

PLUGIN CONFIGURATION

33 | SMSEagle NXS-9750 | User’s Manual

Screenshot from SMS to Email settings

• if you want to use the plugin, set ‘Enable forwarding to email’ to ‘Yes’
• choose a type of email forwarding: “To email of last sending user” (so called “Two-way Email2SMS
& SMS&Email”) or “To fixed email address”
• enter an email subject
• enter SMTP configuration for your SMTP server that will be used for sending emails

EMAIL TEXT FROM PLUGIN

Email body from SMS To Email plugin contains:

• phone number from incoming SMS (and phonebook contact name if found)
• Date, time when SMS is received
• SMS message

Example email text:

From: +483334455 (John Doe)
Received: 2017-06-01 14:38:12
Message: My SMS message

Callback URL plugin

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.

PLUGIN CONFIGURATION
Plugin “Callback URL” allows to add unlimited number of rules. Each rule can be enabled or disabled by user.

Screenshot from Callback URL settings

34 | SMSEagle NXS-9750 | User’s Manual

For each new rule user has to fill in the requested fields:

• ‘URL’ field defines remote address of your callback script

• ‘Test URL’ button allows to test whether your Callback URL configuration is correct. SMSEagle will
make a callback request with test parameters and will verify the response of remote server
• ‘URL method’ allows to choose whether callback to your URL is done with HTTP(S) GET or POST
method
• “Send request when” defines if the request is always sent, sent only when SMS sender belongs to a
given contact/group or only when incoming message contains a given character string
• Optionally you can define “API key of your service” value. This will be passed to your callback URL in
parameter ‘apikey’. If you leave the field blank, ‘apikey’ parameter will not be passed to your
callback URL
• User may also choose whether to enable support of self-signed SSL certificate

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:

35 | SMSEagle NXS-9750 | User’s Manual

SMS Forward

The plugin “SMS forward” allows to forward incoming SMS messages to one/may recipients according to
defined rules.

PLUGIN CONFIGURATION
Plugin “SMS Forward” allows to add many forwarding rules. Each rule can be enabled or disabled by user.

Screenshot from plugin main window

For each rule user can define:

• When incoming SMS should be forwarded (Rule type) and to what number(s) the message should
be forwarded (SMS Recipient).
• Whether or not include in SMS a sender number from which original SMS came from.
• When defining a rule user can choose SMS recipient (who gets the forwarded SMS). It can be
either phone number or name of group from phonebook.
• User may define many forwarding rules in the plugin.
• Message header can be set to include original sender number or not to include.
• Each rule is processed independently.
• There is a possibility to enable/disable each rule.

Screenshot form “Add/edit forwarding rule”

36 | SMSEagle NXS-9750 | User’s Manual

Periodic SMS

The plugin “Periodic SMS” allows to send SMS messages or USSD codes at a desired time interval. User may
define many sending rules, and each rule will be processed independently.

PLUGIN CONFIGURATION
Plugin “Periodic SMS” allows to add many sending rules. Each rule can be enabled or disabled by user.

Screenshot from main plugin window

For each rule the user can define:

• The rule name

• 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)

37 | SMSEagle NXS-9750 | User’s Manual

Screenshot from “Add new rule” window

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. On the other hand the digital outputs may be used to activate external
devices connected to the outputs when certain SMS messages are received by SMSEagle.

Number of available DI/DO ports depends on hardware revision:

Port type Hardware Rev.3 Hardware Rev.2, Rev.1

DI 4 2
DO 4 2

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) +5V 0V
HIGH (1) 0 +5 V

38 | SMSEagle NXS-9750 | User’s Manual

USING DIGITAL OUTPUTS
From digital output, without side effects, you can directly control external circuit with a voltage not exceeding
5V and a current of max. 450mA.
But the safest form of control external circuits is using an intermediary relay with a protection diode. Usage
example has been shown on the picture below.

Warning: If you plan to use digital output with relay, it is strongly recommended to connect a separate protection
diode (a.k.a. “snubber”) across the relay coil terminals as well. A diode snubber circuit can be added when ordering
from some relay manufacturers. This diode is installed in the direction that does not ordinarily allow current to
conduct. When current to the inductive load is rapidly interrupted, a large voltage spike is produced in the reverse
direction as the inductor attempts to keep current flowing in the circuit. Placing the snubber diode in parallel with the
inductive load for reversed-bias flow allows the current from the inductor to flow through the diode rather than
through the switching element, dissipating the energy stored in the inductive load from its series resistance and
instead goes through the much smaller resistance of the diode.

Digital Output - example of usage with external relay

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”
should be tied to a logic “1” or logic “0” as appropriate for the circuit. We do this by using what are commonly
called Pull-up Resistors to give the input pin a defined default state, if there is nothing is connected to it. This
can be observed with a voltage level of 3-5V on unconnected digital input.

39 | SMSEagle NXS-9750 | User’s Manual

 Digital Input - most simple usage. Optional 500 Ohm resistor is needed when using long cables

Digital Input - connection example with a device with open collector output

40 | SMSEagle NXS-9750 | User’s Manual

Digital Input - connection example with a device with 24V output
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.

Screenshot from plugin window

DIGITAL INPUTS
For each processing rule for digital input user can define:

• The rule name

• Port number (1,2)
• State of input signal that will trigger sending of SMS message (field “When input signal”)
• SMS text (field “Send SMS message”)
• The recipient’s name from phonebook

41 | SMSEagle NXS-9750 | User’s Manual

Screenshot from digital input “Add or edit rule” window

DIGITAL OUTPUTS
For each processing rule for digital output user can define:

• The rule name

• Port number (1,2)
• On what condition digital output should be set (all incoming messages, when incoming SMS comes
from specified contact in phonebook or when incoming 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

42 | SMSEagle NXS-9750 | User’s Manual

Screenshot from digital output “Add or edit rule” window

Temperature & humidity sensor

The NXS-family of SMSEagle devices is equipped with internal temperature and humidity sensor. The
DHT22 sensor allows to measure temperature with ±0.5°C accuracy and humidity with ±2% RH accuracy.
The measured temperature and humidity values can be displayed in web-gui of SMSEagle and used to
trigger SMS message to single/many recipients.

43 | SMSEagle NXS-9750 | User’s Manual

Screenshot from plugin main window

PLUGIN CONFIGURATION - ALARMS

Tab “Alarms” allows to define triggering rules for SMS alarms for temperature and humidity. User may
define several processing rules.

Screenshot from “Alarms” window

For each processing rule for digital output user can define:

• The rule name

• Sensor (currently only 1 sensor is available)
• 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

44 | SMSEagle NXS-9750 | User’s Manual

Screenshot from “Add or edit rule” window

PLUGIN CONFIGURATION - SETTINGS

Tab “Settings” allows to control sensor settings. User may enable/disable sensor and set sensor reading
period (in minutes).

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.

45 | SMSEagle NXS-9750 | 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.

In the “AD phone attribute” field user needs to choose which phone attribute from AD will be shown in
SMSEagle web-gui.

Screenshot from “LDAP settings” window

Click “Save” and “Test connection” to make sure that SMSEagle is connected with AD server.

46 | SMSEagle NXS-9750 | User’s Manual

Screenshot showing successful connection to AD server.

With connection established, AD contacts/groups suggestions are shown in selected modules of Web-GUI.
Start typing any part of contact/group name or number to show AD contact suggestions.

Type “LDAP” (case sensitive) to check all contacts listed in AD directory.

Screenshot from “Compose” module with LDAP connection enabled

LDAP directory suggestions can be used in “Compose”, “Autoreply” and “Digital input/output” modules.

Blacklist

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

47 | SMSEagle NXS-9750 | User’s Manual

MULTIMODEM FEATURES

SMSeagle NXS-9750 is equipped with two built-in modems. You can manage modem settings in web-gui
menu Settings > Maintenance Tab. There are following options available for multimodem device:

Multimodem selection strategy

This setting is responsible for modem choice strategy when sending SMS messages from SMSEagle. The
following options are possible:

• Round-robin
In this strategy modems are selected sequentially one-by-one when sending out SMS messages.
This means that device sends messages using modem1 > modem2 > modem1 > modem2, etc.
• SIM1 as Master modem
In this strategy modem1 is always selected when sending out SMS messages. If failover is enabled
(see below) modem2 will be always used as a backup in failover strategy
• SIM2 as Master modem
In this strategy modem1 is always selected when sending out SMS messages. If failover is enabled
(see below) modem2 will be always used as a backup in failover strategy

Enable modem failover mechanism

If this setting is enabled, when one modem stops working other will automatically take over his job. This
feature requires at least two active SIM cards in the device. The health check for each modem is performed
with 3 minutes frequency. If during a health check a modem is not connected to network the other will
automatically take over his jobs (including messages waiting in Outbox folder).

48 | SMSEagle NXS-9750 | 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.

Please note, that SMSEagle API supports both HTTP and HTTPS protocol.

For your convenience sample usage of SMSEagle’s API in most popular programming languages are available
at: http://www.smseagle.eu/code-samples/

0. API Authentication
Before you can start using API, first you need to enable API access.

a) go to WebGUI > Users

b) create a new User with access level "User", set "Access to API" to "On" (optionally you may limit
access only to selected API methods)
c) choose API authentication method. This can be either:
• access_token (recommended solution)
Edit your API User > check “Enable token” and generate new access token. The token will
be used to authenticate in API methods
or
• b) login and password
Use your API User credentials to authenticate in API methods

EXAMPLES OF AUTHENTICATION:
• with access token
https://url-of-smseagle/http_api/send_sms?access_token=0001gOjCOlMH8F2q
• with login and password
https://url-of-smseagle/http_api/send_sms?login=john&pass=doe

API credentials created here will be used to authenticate in all API methods (see descriptions below).

1. Send SMS: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/send_sms

PARAMETERS:

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

to recipient telephone number (or numbers separated with comma)

49 | SMSEagle NXS-9750 | User’s Manual

 message your SMS message

date (optional parameter) date and time in format YYYYmmDDHHMM (YYYY – year,
mm – month, DD – day, HH – hour, MM – minute). If this parameter is not null
SMS will be scheduled for sending at the given date and time

highpriority (optional parameter) 0 = normal priority, 1 = SMS will have higher priority in
Outbox queue when processed by GSM-modem

unicode (optional parameter) 0 = no Unicode encoding (default), 1 = SMS will be encoded

using Unicode (you can send national characters)

flash (optional parameter) 0 = normal SMS (default), 1 = SMS will be sent as flash
message

oid (optional parameter) This attribute specifies a user-defined unique ID that is

assigned to a message-recipient pair. The oid is a varchar (36) that uniquely
identifies a message sent to a particular recipient (particular phone number).
The value of this ID allows client applications to match incoming reply messages
to outgoing messages. If no oid was assigned to the outgoing message this
attribute will have a value of null for incoming message.

The oid value will be automatically assigned to incoming message only if

incoming phone number matches exactly the phone number (including country
code) from outgoing message.

modem_no (optional parameter) sending modem number (only for multimodem devices)

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

validity (optional parameter) How long will be the message valid. If message expires
before it is received by a phone, the message will be discarded by cellular
network. Acceptable parameter values: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d,
5d, 1w, 2w, 4w, max. Default value: max

send_after (optional parameter) send a message after specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)

send_before (optional parameter) send a message before specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)

EXAMPLES:
https://url-of-smseagle/http_api/send_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&message=mymessage

https://url-of-smseagle/http_api/send_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&message=mymessage&
date=201401152132

https://url-of-smseagle/http_api/send_sms?

50 | SMSEagle NXS-9750 | User’s Manual

access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&message=mymessage&
highpriority=1

RESPONSE:
Response: OK; ID=[ID of message in outbox]
Sample response: OK; ID=297

Response (when wrong logindata): Invalid login or password

Response (when wrong access token: Invalid access token
Response (when wrong parameters): Wrong parameters

RESPONSE (XML):
Response:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<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.

51 | SMSEagle NXS-9750 | User’s Manual

2. Send SMS: JSONRPC method

HTTP POST METHOD:

https://url-of-smseagle/jsonrpc/sms

PARAMETERS:

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

to recipient telephone number (or numbers separated with comma)

message your SMS message

date (optional parameter) date and time in format YYYYmmDDHHMM (YYYY – year,
mm – month, DD – day, HH – hour, MM – minute). If this parameter is not null
SMS will be scheduled for sending at the given date and time

highpriority (optional parameter) 0 = normal priority, 1 = SMS will have higher priority in
Outbox queue when processed by GSM-modem

unicode (optional parameter) 0 = no Unicode encoding (default), 1 = SMS will be encoded

using Unicode (you can send national characters)

flash (optional parameter) 0 = normal SMS (default), 1 = SMS will be sent as flash
message

oid (optional parameter) This attribute specifies a user-defined unique ID that is

assigned to a message-recipient pair. The oid is a varchar(36) that uniquely
identifies a message sent to a particular recipient (particular phone number).
The value of this ID allows client applications to match incoming reply messages
to outgoing messages. If no oid was assigned to the outgoing message this
attribute will have a value of null for incoming message.

The oid value will be automatically assigned to incoming message only if

incoming phone number matches exactly the phone number (including country
code) from outgoing message.

modem_no (optional parameter) sending modem number (only for multimodem devices)

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

validity (optional parameter) How long will be the message valid. If message expires
before it is received by a phone, the message will be discarded by cellular
network. Acceptable parameter values: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d,
5d, 1w, 2w, 4w, max. Default value: max
send_after (optional parameter) send a message after specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)

52 | SMSEagle NXS-9750 | User’s Manual

 send_before (optional parameter) send a message before specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)

SAMPLE BODY:
{"method":"sms.send_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"to":"481234567
″,"message":"My message"}}
or
{"method":"sms.send_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"to":"481234567
″,"message":"My message","date":"201401152132″}}
or
{"method":"sms.send_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"to":"481234567
″,"message":"My message","highpriority":"1″}}

RESPONSE:
Response: {"result": "OK; ID=[ID of message in outbox]"}
Sample response: {"result": "OK; ID=297"}

Response (when wrong logindata): {"result": "Invalid login or password"}

Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters): {"result": "Wrong parameters"}

RESPONSE (EXTENDED):
Response:
{"result": {"message_id":"[ID of message in outbox]","status":"ok"}}

Sample response: {"result": {"message_id":"748","status":"ok"}}

Sample response when parameter “to” contains multiple phone numbers:

{"result":[{"message_id":"3643","status":"ok"},{"message_id":"3644","status
":"ok"},{"message_id":"3645","status":"ok"},{"message_id":"3646","status":"
ok"},{"message_id":"3647","status":"ok"}]}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong parameters","status":"error"}}

3. Send SMS to a group: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/send_togroup

Parameter Description

53 | SMSEagle NXS-9750 | User’s Manual

 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 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 – year,
mm – month, DD – day, HH – hour, MM – minute). If this parameter is not null
SMS will be scheduled for sending at the given date and time

highpriority (optional parameter) 0 = normal priority, 1 = SMS will have higher priority in
Outbox queue when processed by GSM-modem

unicode (optional parameter) 0 = no Unicode encoding (default), 1 = SMS will be encoded

using Unicode (you can send national characters)

flash (optional parameter) 0 = normal SMS (default), 1 = SMS will be sent as flash
message

modem_no (optional parameter) sending modem number (only for multimodem devices)

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

validity (optional parameter) How long will be the message valid. If message expires
before it is received by a phone, the message will be discarded by cellular
network. Acceptable parameter values: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d,
5d, 1w, 2w, 4w, max. Default value: max
send_after (optional parameter) send a message after specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)
send_before (optional parameter) send a message before specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)

EXAMPLES:
https://url-of-smseagle/http_api/send_togroup?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=admins&message=myme
ssage

https://url-of-smseagle/http_api/send_togroup?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=admins&message=myme
ssage&date=201401152132

https://url-of-smseagle/http_api/send_togroup?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=admins&message=myme
ssage&highpriority=1

RESPONSE:
Response: OK; ID=[ID of message in outbox]

54 | SMSEagle NXS-9750 | User’s Manual

Sample response: OK; ID=297

Response (when wrong logindata): Invalid login or password

Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong parameters

RESPONSE (XML):
Response:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<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>

4. Send SMS to a group: JSONRPC method

HTTP POST METHOD:

https://url-of-smseagle/jsonrpc/sms

Parameter Description

access_token authentication access token (see details in point API Authentication)

55 | SMSEagle NXS-9750 | User’s Manual

 login your user to login to 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 – year,
mm – month, DD – day, HH – hour, MM – minute). If this parameter is not null
SMS will be scheduled for sending at the given date and time

highpriority (optional parameter) 0 = normal priority, 1 = SMS will have higher priority in
Outbox queue when processed by GSM-modem

unicode (optional parameter) 0 = no Unicode encoding (default), 1 = SMS will be encoded

using Unicode (you can send national characters)

flash (optional parameter) 0 = normal SMS (default), 1 = SMS will be sent as flash
message

modem_no (optional parameter) sending modem number (only for multimodem devices)

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

validity (optional parameter) How long will be the message valid. If message expires
before it is received by a phone, the message will be discarded by cellular
network. Acceptable parameter values: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d,
5d, 1w, 2w, 4w, max. Default value: max
send_after (optional parameter) send a message after specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)
send_before (optional parameter) send a message before specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)

EXAMPLES:
{"method":"sms.send_togroup",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"groupname":"ad
mins","message":"mymessage"}}
or
{"method":"sms.send_togroup",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"groupname":"ad
mins","message":"mymessage","date":"201401152132"}}
or
{"method":"sms.send_togroup",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"groupname":"ad
mins","message":"mymessage","highpriority":"1"}}

RESPONSE:
Response: {"result": "OK; ID=[ID of message in outbox]"}

56 | SMSEagle NXS-9750 | User’s Manual

Sample response: {"result": "OK; ID=[297]"}

Response (when wrong logindata): {"result": "Invalid login or password"}

Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters): {"result": "Wrong parameters"}

RESPONSE (EXTENDED):
Response:
{"result": {"message_id":"[ID of message in outbox]","status":"ok"}}

Sample response: {"result": {"message_id":"748","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong parameters","status":"error"}}

5. Send SMS to contact: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/send_tocontact

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 contact name (or names separated by comma) defined in your SMSEagle
Phonebook. Contacts must be defined as Public

message your SMS message

date (optional parameter) date and time in format YYYYmmDDHHMM (YYYY – year,
mm – month, DD – day, HH – hour, MM – minute). If this parameter is not null
SMS will be scheduled for sending at the given date and time

highpriority (optional parameter) 0 = normal priority, 1 = SMS will have higher priority in
Outbox queue when processed by GSM-modem

unicode (optional parameter) 0 = no Unicode encoding (default), 1 = SMS will be encoded

using Unicode (you can send national characters)

flash (optional parameter) 0 = normal SMS (default), 1 = SMS will be sent as flash
message

modem_no (optional parameter) sending modem number (only for multimodem devices)

57 | SMSEagle NXS-9750 | User’s Manual

 responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

validity (optional parameter) How long will be the message valid. If message expires
before it is received by a phone, the message will be discarded by cellular
network. Acceptable parameter values: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d,
5d, 1w, 2w, 4w, max. Default value: max
send_after (optional parameter) send a message after specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)
send_before (optional parameter) send a message before specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)

EXAMPLES:
https://url-of-smseagle/http_api/send_tocontact?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&message=m
ymessage

https://url-of-smseagle/http_api/send_tocontact?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&message=m
ymessage&date=201401152132

https://url-of-smseagle/http_api/send_tocontact?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&message=m
ymessage&highpriority=1

RESPONSE:
Response: OK; ID=[ID of message in outbox]
Sample response: OK; ID=297

Response (when wrong logindata): Invalid login or password

Response (when wrong access token): Invalid access token
Response (when contact doesn’t exist): Invalid contact name – [contact_name]
Response (when wrong parameters): Wrong parameters

RESPONSE (XML):
Response:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<message_id>297</message_id>

58 | SMSEagle NXS-9750 | User’s Manual

 <status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when contact doesn’t exist):

<xml>
<error_text>Invalid contact name – [contact_name]</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

6. Send SMS to contact: JSONRPC method

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

contactname contact name defined in your SMSEagle Phonebook. The contact must be
defined as Public

message your SMS message

date (optional parameter) date and time in format YYYYmmDDHHMM (YYYY – year,
mm – month, DD – day, HH – hour, MM – minute). If this parameter is not null
SMS will be scheduled for sending at the given date and time

highpriority (optional parameter) 0 = normal priority, 1 = SMS will have higher priority in
Outbox queue when processed by GSM-modem

59 | SMSEagle NXS-9750 | User’s Manual

 unicode (optional parameter) 0 = no Unicode encoding (default), 1 = SMS will be encoded
using Unicode (you can send national characters)

flash (optional parameter) 0 = normal SMS (default), 1 = SMS will be sent as flash
message

modem_no (optional parameter) sending modem number (only for multimodem devices)

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

validity (optional parameter) How long will be the message valid. If message expires
before it is received by a phone, the message will be discarded by cellular
network. Acceptable parameter values: 5m, 10m, 30m, 1h, 2h, 4h, 12h, 1d, 2d,
5d, 1w, 2w, 4w, max. Default value: max
send_after (optional parameter) send a message after specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)
send_before (optional parameter) send a message before specified time. It can be used to
prevent messages from being sent at night. Format: HH:MM:SS (HH – hour, MM
– minute, SS – second)

EXAMPLES:
{"method":"sms.send_tocontact",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"contactname":"
johndoe","message":"mymessage"}}
or
{"method":"sms.send_tocontact",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"contactname":"
johndoe","message":"mymessage","date":"201401152132"}}
or
{"method":"sms.send_tocontact",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"contactname":"
johndoe","message":"mymessage","highpriority":"1"}}

RESPONSE:
Response: {"result": "OK; ID=[ID of message in outbox]"}
Sample response: {"result": "OK; ID=[297]"}

Response (when wrong logindata): {"result": "Invalid login or password"}

Response (when wrong access token): {"result": "Invalid access token"}
Response (when contact doesn’t exist): {"result": "Invalid contact name –
contact_name]"}
Response (when wrong parameters): {"result": "Wrong parameters"}

RESPONSE (EXTENDED):
Response:

60 | SMSEagle NXS-9750 | User’s Manual

{"result": {"message_id":"[ID of message in outbox]","status":"ok"}}

Sample response: {"result": {"message_id":"748","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when contact doesn’t exist):

{"result": {"error_text":"Invalid contact name –
contact_name]","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong parameters","status":"error"}}

7. Send USSD code: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/send_ussd

Parameters:
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

to USSD code (urlencoded)

modem_no (optional parameter) sending modem number (only for multimodem devices)

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/send_ussd?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to= %2A101%23

RESPONSE:
Response: OK; ID=[ID of message in outbox]
Sample response: OK; ID=297

Response (when wrong logindata): Invalid login or password

Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong parameters

61 | SMSEagle NXS-9750 | User’s Manual

RESPONSE (XML):
Response:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<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 urlencode USSD code before sending it to gateway. Response from GSM/3G network
will show up in device Inbox folder.

8. Send USSD code: JSONRPC method

HTTP POST METHOD:

https://url-of-smseagle/jsonrpc/sms

Parameters:
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)

62 | SMSEagle NXS-9750 | User’s Manual

 pass your password to login to SMSEagle

to USSD code

modem_no (optional parameter) sending modem number (only for multimodem devices)

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

SAMPLE BODY:
{"method":"sms.send_ussd",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"to":"*101#″}}

RESPONSE:
Response: {"result": "OK; ID=[ID of message in outbox]"}
Sample response: {"result": "OK; ID=297"}

Response (when wrong logindata): {"result": "Invalid login or password"}

Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters): {"result": "Wrong parameters"}

RESPONSE (EXTENDED):
Response:
{"result": {"message_id":"[ID of message in outbox]","status":"ok"}}

Sample response: {"result": {"message_id":"748","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong parameters","status":"error"}}

Important notice: Response from GSM/3G network will show up in device Inbox folder.

9. Send binary SMS: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/send_binary_sms

PARAMETERS:

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)

63 | SMSEagle NXS-9750 | User’s Manual

 pass your password to login to SMSEagle

to recipient telephone number (or numbers separated with comma)

udh (optional parameter) UDH header for the message (in hex format)

data binary message (in hex format)

class (optional parameter) message class

modem_no (optional parameter) sending modem number (only for multimodem devices)
responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object
EXAMPLES:
https://url-of-smseagle/http_api/send_binary_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=1234567&udh=0605040B8423F0
&data=EA0601AE02056A0045C60C037777772E736D736561676C652E657500080103534D534
561676C65000101

RESPONSE:
Response: OK; ID=[ID of message in outbox]
Sample response: OK; ID=297

Response (when wrong logindata): Invalid login or password

Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong or missing >>udh<< parameter
Response (when wrong parameters): Wrong or missing >>data<< parameter

RESPONSE (XML):

Response:
<xml>
<message_id>[ID of message in outbox]</message_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<message_id>297</message_id>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

64 | SMSEagle NXS-9750 | User’s Manual

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text> Wrong or missing >>udh<< parameter </error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text> Wrong or missing >>data<< parameter </error_text>
<status>error</status>
</xml>

10. Send binary SMS: JSONRPC method

HTTP POST METHOD:

https://url-of-smseagle/jsonrpc/sms

PARAMETERS:

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

to recipient telephone number (or numbers separated with comma)

udh (optional parameter) UDH header for the message (in hex format)

data binary message (in hex format)

class (optional parameter) message class

modem_no (optional parameter) sending modem number (only for multimodem devices)

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"sms.send_binary_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"to":"1234567",
"udh":"0605040B8423F0","data":"EA0601AE02056A0045C60C037777772E736D73656167
6C652E657500080103534D534561676C65000101"}}

65 | SMSEagle NXS-9750 | User’s Manual

RESPONSE:
Response: {"result": "OK; ID=[ID of message in outbox]"}
Sample response: {"result": "OK; ID=297"}

Response (when wrong logindata): {"result": "Invalid login or password"}

Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters): {"result": "Wrong or missing >>udh<< parameter"}
Response (when wrong parameters): {"result": "Wrong or missing >>data<< parameter"}

RESPONSE (EXTENDED):
Response:
{"result": {"message_id":"[ID of message in outbox]","status":"ok"}}

Sample response: {"result": {"message_id":"748","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>udh<< parameter",
"status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>data<< parameter",
"status":"error"}}

11. Read SMS: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/read_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

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)

to (optional parameter) telephone number of SMS receiver (for sentitems)

66 | SMSEagle NXS-9750 | User’s Manual

 datefrom (optional parameter) date and time in format YYYYmmDDHHMMSS (YYYY – year,
mm – month, DD – day, HH – hour, MM – minutes, SS – seconds). Show only
messages sent/received on this date/time and later

dateto (optional parameter) date and time in format YYYYmmDDHHMMSS (YYYY – year,
mm – month, DD – day, HH – hour, MM – minutes, SS – seconds). Show only
messages sent/received on this date/time and earlier

limit (optional parameter) how many messages to show

unread (optional parameter) 1 = show only unread messages

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

createdby (optional parameter) username or email (if message was sent via Email to SMS) of
sending user

modem_no (optional parameter) sending modem number (only for multimodem devices)

EXAMPLES:
Show all messages from inbox:
https://url-of-smseagle/http_api/read_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox

Show all unread messages from inbox:

https://url-of-smseagle/http_api/read_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox&unread=1

Show messages from sentitems folder with id=1234 to 1236:

https://url-of-smseagle/http_api/read_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=sentitems&idfrom=1234&
idto=1236

Show messages from inbox folder with sender phone number +481234567:
https://url-of-smseagle/http_api/read_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox&from=+481234567

Show messages from sentitems folder with receiver phone number 7654321 and
datetime from 2014-12-24 08:10:00 to 2014-12-31 23:59:59:
https://url-of-smseagle/http_api/read_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=sentitems&to=7654321&d
atefrom=20141224081000&dateto=20141231235959

RESPONSE:
Sample responses: inbox folder, sentitems folder
Response (when no data): No data to display
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong parameters

67 | SMSEagle NXS-9750 | User’s Manual

RESPONSE (XML):
Sample response (inbox folder):
<xml>
<messages>
<item>
<UpdatedInDB>2018-07-17 15:11:31</UpdatedInDB>
<ReceivingDateTime>2018-07-17 15:04:04</ReceivingDateTime>
<Text>005400650073007400200031</Text>
<SenderNumber>+48123456789</SenderNumber>
<Coding>Default_No_Compression</Coding>
<UDH></UDH>
<SMSCNumber>+48790998250</SMSCNumber>
<Class>-1</Class>
<TextDecoded>Test 1</TextDecoded>
<ID>124</ID>
<RecipientID>smseagle1</RecipientID>
<Processed>t</Processed>
<id_folder>1</id_folder>
<readed>true</readed>
<oid></oid>
<Status>0</Status>
</item>
<item>
<UpdatedInDB>2018-07-17 15:11:31</UpdatedInDB>
<ReceivingDateTime>2018-07-17 15:04:10</ReceivingDateTime>
<Text>005400650073007400200032</Text>
<SenderNumber>+48123456788</SenderNumber>
<Coding>Default_No_Compression</Coding>
<UDH></UDH>
<SMSCNumber>+48790998250</SMSCNumber>
<Class>-1</Class>
<TextDecoded>Test 2</TextDecoded>
<ID>125</ID>
<RecipientID>smseagle1</RecipientID>
<Processed>t</Processed>
<id_folder>1</id_folder>
<readed>true</readed>
<oid>5208facc-5912-4d21-8d31-7f830cf8f24e</oid>
<Status>0</Status>
</item>
<item>
<UpdatedInDB>2018-07-17 15:11:31</UpdatedInDB>
<ReceivingDateTime>2018-07-17 15:05:49</ReceivingDateTime>

<Text>004C006F00720065006D00200069007000730075006D00200064006F006C006F00720
02000730069007400200061006D00650074002C00200063006F006E00730065006300740065
007400750072002000610064006900700069007300630069006E006700200065006C0069007
4002E002000430072006100730020006600650072006D0065006E00740075006D0020007500
6C006C0061006D0063006F007200700065007200200065006700650073007400610073002E0
020004E0075006C006C006100200070006C006100630065007200610074002000660069006E
006900620075007300200064006F006C006F0072002C0020006D0061006C006500730075006
10064006100200076006100720069007500730020006C006900670075006C00610020006800
65006E006400720065</Text>
<SenderNumber>+48123456787</SenderNumber>
<Coding>Default_No_Compression</Coding>
<UDH>050003590301</UDH>
<SMSCNumber>+48790998250</SMSCNumber>
<Class>-1</Class>
<TextDecoded>Lorem ipsum dolor sit amet, consectetur adipiscing
elit. Cras fermentum ullamcorper egestas. Nulla placerat finibus dolor,
malesuada varius ligula hendrerit sed. Nullam nisl sapien, molestie rhoncus

68 | SMSEagle NXS-9750 | User’s Manual

orci vel, viverra luctus ipsum. Praesent maximus luctus orci. Vestibulum
lacus dui, vestibulum ac aliquam eget, ultrices et mi. In ac felis urna.
Phasellus eget leo a leo congue ultricies. Donec tincidunt volutpat arcu a
commodo</TextDecoded>
<ID>126</ID>
<RecipientID>smseagle1</RecipientID>
<Processed>t</Processed>
<id_folder>1</id_folder>
<readed>true</readed>
<oid></oid>
<Status>0</Status>
</item>
</messages>
<status>ok</status>
</xml>

Sample response (sentitems folder):

<xml>
<messages>
<item>
<UpdatedInDB>2018-06-07 11:29:56</UpdatedInDB>
<InsertIntoDB>2018-06-07 11:29:43</InsertIntoDB>
<SendingDateTime>2018-06-07 11:29:56</SendingDateTime>
<DeliveryDateTime>2018-06-07 11:30:05</DeliveryDateTime>
<Text>0074006500730074</Text>
<DestinationNumber>123456789</DestinationNumber>
<Coding>Default_No_Compression</Coding>
<UDH></UDH>
<SMSCNumber>+48501200777</SMSCNumber>
<Class>-1</Class>
<TextDecoded>test</TextDecoded>
<ID>456</ID>
<SenderID>smseagle1</SenderID>
<SequencePosition>1</SequencePosition>
<Status>DeliveryOK</Status>
<StatusError>-1</StatusError>
<TPMR>116</TPMR>
<RelativeValidity>255</RelativeValidity>
<CreatorID>admin</CreatorID>
<id_folder>3</id_folder>
<StatusCode>-1</StatusCode>
</item>
<item>
<UpdatedInDB>2018-07-13 11:40:45</UpdatedInDB>
<InsertIntoDB>2018-07-13 11:40:40</InsertIntoDB>
<SendingDateTime>2018-07-13 11:40:45</SendingDateTime>
<DeliveryDateTime></DeliveryDateTime>
<Text></Text>
<DestinationNumber>*101#</DestinationNumber>
<Coding>8bit</Coding>
<UDH></UDH>
<SMSCNumber>+48501200777</SMSCNumber>
<Class>127</Class>
<TextDecoded></TextDecoded>
<ID>525</ID>
<SenderID>smseagle1</SenderID>
<SequencePosition>1</SequencePosition>
<Status>SendingOK</Status>
<StatusError>-1</StatusError>
<TPMR>-1</TPMR>
<RelativeValidity>255</RelativeValidity>
<CreatorID>admin</CreatorID>

69 | SMSEagle NXS-9750 | User’s Manual

 <id_folder>3</id_folder>
<StatusCode>-1</StatusCode>
</item>
<item>
<UpdatedInDB>2018-07-18 14:25:41</UpdatedInDB>
<InsertIntoDB>2018-07-18 14:25:23</InsertIntoDB>
<SendingDateTime>2018-07-18 14:25:28</SendingDateTime>
<DeliveryDateTime>2018-07-18 14:25:28</DeliveryDateTime>
<Text>0054006500730074002000740065007300740031</Text>
<DestinationNumber>+48123456788</DestinationNumber>
<Coding>Default_No_Compression</Coding>
<UDH></UDH>
<SMSCNumber>+48601000310</SMSCNumber>
<Class>-1</Class>
<TextDecoded>Test test1</TextDecoded>
<ID>574</ID>
<SenderID>smseagle1</SenderID>
<SequencePosition>1</SequencePosition>
<Status>DeliveryOK</Status>
<StatusError>0</StatusError>
<TPMR>84</TPMR>
<RelativeValidity>255</RelativeValidity>
<CreatorID>admin</CreatorID>
<id_folder>3</id_folder>
<StatusCode>-1</StatusCode>
</item>
<item>
<UpdatedInDB>2018-07-18 14:27:13</UpdatedInDB>
<InsertIntoDB>2018-07-18 14:27:03</InsertIntoDB>
<SendingDateTime>2018-07-18 14:27:13</SendingDateTime>
<DeliveryDateTime></DeliveryDateTime>

<Text>00540065007300740020007700690074006800200075006E00690063006F006400650
0200065006E0063006F00640069006E0067003A00200105014200F30119017A0107</Text>
<DestinationNumber>123456788</DestinationNumber>
<Coding>Unicode_No_Compression</Coding>
<UDH></UDH>
<SMSCNumber>+48601000310</SMSCNumber>
<Class>-1</Class>
<TextDecoded>Test with unicode encoding: ąłóęźć</TextDecoded>
<ID>576</ID>
<SenderID>smseagle2</SenderID>
<SequencePosition>1</SequencePosition>
<Status>SendingOK</Status>
<StatusError>-1</StatusError>
<TPMR>86</TPMR>
<RelativeValidity>255</RelativeValidity>
<CreatorID>admin</CreatorID>
<id_folder>3</id_folder>
<StatusCode>-1</StatusCode>
</item>
<item>
<UpdatedInDB>2018-07-18 14:27:36</UpdatedInDB>
<InsertIntoDB>2018-07-18 14:27:32</InsertIntoDB>
<SendingDateTime>2018-07-18 14:27:36</SendingDateTime>
<DeliveryDateTime></DeliveryDateTime>

<Text>00540065007300740020006F006600200066006C0061007300680020006D006500730
073006100670065</Text>
<DestinationNumber>123456788</DestinationNumber>
<Coding>Default_No_Compression</Coding>
<UDH></UDH>
<SMSCNumber>+48601000310</SMSCNumber>
<Class>0</Class>

70 | SMSEagle NXS-9750 | User’s Manual

 <TextDecoded>Test of flash message</TextDecoded>
<ID>577</ID>
<SenderID>smseagle2</SenderID>
<SequencePosition>1</SequencePosition>
<Status>SendingOK</Status>
<StatusError>-1</StatusError>
<TPMR>87</TPMR>
<RelativeValidity>255</RelativeValidity>
<CreatorID>admin</CreatorID>
<id_folder>3</id_folder>
<StatusCode>-1</StatusCode>
</item>
<item>
<UpdatedInDB>2018-07-18 14:29:29</UpdatedInDB>
<InsertIntoDB>2018-07-18 14:28:46</InsertIntoDB>
<SendingDateTime>2018-07-18 14:29:29</SendingDateTime>
<DeliveryDateTime></DeliveryDateTime>

<Text>0054006500730074002000770069007400680020006200610064002000700068006F0
06E00650020006E0075006D006200650072</Text>
<DestinationNumber>11</DestinationNumber>
<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>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>

71 | SMSEagle NXS-9750 | User’s Manual

</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong parameters</error_text>
<status>error</status>
</xml>

FIELD DESCRIPTION OF RESPONSE DATA – INBOX FOLDER:

Field Data type Description

UpdatedInDB timestamp when somebody (software, user) updated the
message content or state
ReceivingDateTime timestamp when SMS was received
Text text SMS text encoded using hex values
SenderNumber character varying (30) SMS sender number
Coding character varying (255) SMS text coding. Possible values:
‘Default_No_Compression’, ‘Unicode_No_Compression’,
‘8bit’,
‘Default_Compression’,
‘Unicode_Compression’
UDH text User Data Header encoded using hex values
SMSCNumber character varying (20) SMSC number
Class integer SMS class (0 is flash SMS, -1 is normal SMS, 127 is
USSD)
TextDecoded text decoded SMS text
ID serial 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:
1 Inbox
5 Trash
11… Custom folder
readed text whether SMS was read in GUI or via API
oid character varying (36) user-defined unique ID that is assigned to a message-
recipient pair. The oid uniquely identifies a message
sent to a particular recipient (particular phone
number).
More information: see send_sms method description
Status integer Status of incoming message. Currently only used for
USSD messages with following meaning:
1 Unknown status.
2 No action is needed, maybe network initiated USSD.
3 Reply is expected.
4 USSD dialog terminated.

72 | SMSEagle NXS-9750 | User’s Manual

 5 Another client replied.
6 Operation not supported.
7 Network timeout.

FIELD DESCRIPTION OF RESPONSE DATA – SENTITEMS FOLDER:

Field Data type Description

UpdatedInDB timestamp when somebody (software, user) updated the
message content or state
InsertIntoDB timestamp when message was inserted into database
SendingDateTime timestamp when message has been sent
DeliveryDateTime timestamp time of receiving a delivery report (if it has been
enabled). Null if delivery report was not received.
Text text SMS text encoded using hex values
DestinationNumber character varying (30) destination number for SMS
Coding character varying (255) SMS text coding. Possible values:
‘Default_No_Compression’, ‘Unicode_No_Compression’,
‘8bit’,
‘Default_Compression’,
‘Unicode_Compression’
UDH text User Data Header encoded using hex values
SMSCNumber character varying (20) number of SMSC, which sent SMS
Class integer SMS class (0 is flash SMS, -1 is normal SMS, 127 is
USSD)
TextDecoded text decoded SMS text
ID serial 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
Message has been sent, waiting for delivery report
SendingOKNoReport
Message has been sent without asking for delivery
report
SendingError
Sending has failed
DeliveryOK
Delivery report arrived and reported success
DeliveryFailed
Delivery report arrived and reports failure
DeliveryPending
Delivery report announced pending deliver
DeliveryUnknown
Delivery report reported unknown status
Error

73 | SMSEagle NXS-9750 | User’s Manual

 Some other error happened during sending

Notice: some cellular operators return “SendingOK” status

instead of “DeliveryOK” for correctly delivered SMS. If you want
to check for delivery status, please verify what you receive from
your operator or instead use the field DeliveryDateTime.
StatusError integer Status of delivery from delivery report message, codes
are defined in GSM specification 03.40 section
9.2.3.15 (TP-Status)
TPMR integer The Message Reference field (TP-MR) as defined in
GSM 03.40
RelativeValidity integer SMS relative validity (TP-VP) encoded as defined in
GSM 03.40
CreatorID text username that created the SMS message
id_folder integer identification of storage folder. Possible values:
3 Sent items
5 Trash
11… Custom folder
StatusCode integer CMS status code (also known as CMS ERROR) received
from cellular network.
- 1 No CMS Error
> -1 CMS Error occurred. CMS error number is saved in
this field.

12. Read SMS: JSONRPC method

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

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)

to (optional parameter) telephone number of SMS receiver (for sentitems)

datefrom (optional parameter) date and time in format YYYYmmDDHHMMSS (YYYY – year,
mm – month, DD – day, HH – hour, MM – minutes, SS – seconds). Show only
messages sent/received on this date/time and later

74 | SMSEagle NXS-9750 | User’s Manual

 dateto (optional parameter) date and time in format YYYYmmDDHHMMSS (YYYY – year,
mm – month, DD – day, HH – hour, MM – minutes, SS – seconds). Show only
messages sent/received on this date/time and earlier

limit (optional parameter) how many messages to show

unread (optional parameter) 1 = show only unread messages

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

createdby (optional parameter) username or email (if message was sent via Email to SMS) of
sending user

modem_no (optional parameter) sending modem number (only for multimodem devices)

EXAMPLES:
Show all messages from inbox:
{"method":"sms.read_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"folder":"inbox
"}}

Show all unread messages from inbox:

{"method":"sms.read_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"folder":"inbox
","unread":"1"}}

Show messages from sentitems folder with id=1234 to 1236:

{"method":"sms.read_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"folder":"senti
tems","idfrom":"1234","idto":"1236"}}

Show messages from inbox folder with sender phone number +481234567:
{"method":"sms.read_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"folder":"inbox
","from":" 481234567"}}

Show messages from sentitems folder with receiver phone number 7654321 and
datetime from 2014-12-24 08:10:00 to 2014-12-31 23:59:59:
{"method":"sms.read_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"folder":"senti
tems","to":"7654321","datefrom":"20141224081000","dateto":"20141231235959"}
}

RESPONSE:
Sample response (inbox folder):
{
"result": [
{
"UpdatedInDB": "2018-07-18 13:56:16",
"ReceivingDateTime": "2018-07-17 15:04:04",
"Text": "005400650073007400200031",
"SenderNumber": "+48123456789",
"Coding": "Default_No_Compression",

75 | SMSEagle NXS-9750 | User’s Manual

 "UDH": "",
"SMSCNumber": "+48790998250",
"Class": "-1",
"TextDecoded": "Test 1",
"ID": "124",
"RecipientID": "smseagle1",
"Processed": "t",
"id_folder": "1",
"readed": "true",
"oid": "",
"Status": "0"
},
{
"UpdatedInDB": "2018-07-18 13:56:16",
"ReceivingDateTime": "2018-07-17 15:04:10",
"Text": "005400650073007400200032",
"SenderNumber": "+48123456788",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "+48790998250",
"Class": "-1",
"TextDecoded": "Test 2",
"ID": "125",
"RecipientID": "smseagle1",
"Processed": "t",
"id_folder": "1",
"readed": "true",
"oid": "5208facc-5912-4d21-8d31-7f830cf8f24e",
"Status": "0"
},
{
"UpdatedInDB": "2018-07-18 13:56:16",
"ReceivingDateTime": "2018-07-17 15:05:49",
"Text":
"004C006F00720065006D00200069007000730075006D00200064006F006C006F0072002000
730069007400200061006D00650074002C00200063006F006E0073006500630074006500740
0750072002000610064006900700069007300630069006E006700200065006C00690074002E
002000430072006100730020006600650072006D0065006E00740075006D00200075006C006
C0061006D0063006F007200700065007200200065006700650073007400610073002E002000
4E0075006C006C006100200070006C006100630065007200610074002000660069006E00690
0620075007300200064006F006C006F0072002C0020006D0061006C00650073007500610064
006100200076006100720069007500730020006C006900670075006C0061002000680065006
E006400720065",
"SenderNumber": "+48123456787",
"Coding": "Default_No_Compression",
"UDH": "050003590301",
"SMSCNumber": "+48790998250",
"Class": "-1",
"TextDecoded": "Lorem ipsum dolor sit amet, consectetur
adipiscing elit. Cras fermentum ullamcorper egestas. Nulla placerat finibus
dolor, malesuada varius ligula hendrerit sed. Nullam nisl sapien, molestie
rhoncus orci vel, viverra luctus ipsum. Praesent maximus luctus orci.
Vestibulum lacus dui, vestibulum ac aliquam eget, ultrices et mi. In ac
felis urna. Phasellus eget leo a leo congue ultricies. Donec tincidunt
volutpat arcu a commodo",
"ID": "126",
"RecipientID": "smseagle1",
"Processed": "t",
"id_folder": "1",
"readed": "true",
"oid": "",
"Status": "0"
}
]

76 | SMSEagle NXS-9750 | User’s Manual

}

Sample response (sentitems folder):

{
"result": [
{
"UpdatedInDB": "2018-06-07 11:29:56",
"InsertIntoDB": "2018-06-07 11:29:43",
"SendingDateTime": "2018-06-07 11:29:56",
"DeliveryDateTime": "2018-06-07 11:30:05",
"Text": "0074006500730074",
"DestinationNumber": "+48123456789",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "+48501200777",
"Class": "-1",
"TextDecoded": "test",
"ID": "456",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "DeliveryOK",
"StatusError": "-1",
"TPMR": "116",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "-1"
},
{
"UpdatedInDB": "2018-07-13 11:40:45",
"InsertIntoDB": "2018-07-13 11:40:40",
"SendingDateTime": "2018-07-13 11:40:45",
"DeliveryDateTime": null,
"Text": "",
"DestinationNumber": "*101#",
"Coding": "8bit",
"UDH": "",
"SMSCNumber": "+48501200777",
"Class": "127",
"TextDecoded": "",
"ID": "525",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "SendingOK",
"StatusError": "-1",
"TPMR": "-1",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "-1"
},
{
"UpdatedInDB": "2018-07-18 14:25:41",
"InsertIntoDB": "2018-07-18 14:25:23",
"SendingDateTime": "2018-07-18 14:25:28",
"DeliveryDateTime": "2018-07-18 14:25:28",
"Text": "0054006500730074002000740065007300740031",
"DestinationNumber": "+48123456788",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "+48601000310",
"Class": "-1",
"TextDecoded": "Test test1",

77 | SMSEagle NXS-9750 | User’s Manual

 "ID": "574",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "DeliveryOK",
"StatusError": "0",
"TPMR": "84",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "-1"
},
{
"UpdatedInDB": "2018-07-18 14:27:13",
"InsertIntoDB": "2018-07-18 14:27:03",
"SendingDateTime": "2018-07-18 14:27:13",
"DeliveryDateTime": null,
"Text":
"00540065007300740020007700690074006800200075006E00690063006F00640065002000
65006E0063006F00640069006E0067003A00200105014200F30119017A0107",
"DestinationNumber": "123456788",
"Coding": "Unicode_No_Compression",
"UDH": "",
"SMSCNumber": "+48601000310",
"Class": "-1",
"TextDecoded": "Test with unicode encoding: ąłóęźć",
"ID": "576",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "SendingOK",
"StatusError": "-1",
"TPMR": "86",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "-1"
},
{
"UpdatedInDB": "2018-07-18 14:27:36",
"InsertIntoDB": "2018-07-18 14:27:32",
"SendingDateTime": "2018-07-18 14:27:36",
"DeliveryDateTime": null,
"Text":
"00540065007300740020006F006600200066006C0061007300680020006D00650073007300
6100670065",
"DestinationNumber": "123456788",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "+48601000310",
"Class": "0",
"TextDecoded": "Test of flash message",
"ID": "577",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "SendingOK",
"StatusError": "-1",
"TPMR": "87",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "-1"
},
{
"UpdatedInDB": "2018-07-18 14:29:29",
"InsertIntoDB": "2018-07-18 14:28:46",

78 | SMSEagle NXS-9750 | User’s Manual

 "SendingDateTime": "2018-07-18 14:29:29",
"DeliveryDateTime": null,
"Text":
"0054006500730074002000770069007400680020006200610064002000700068006F006E00
650020006E0075006D006200650072",
"DestinationNumber": "11",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "",
"Class": "-1",
"TextDecoded": "Test with bad phone number",
"ID": "578",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "SendingError",
"StatusError": "-1",
"TPMR": "-1",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "21"
}
]
}

Response (when no data): {"result": "No data to display"}

Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters): {"result": "Wrong parameters"}

RESPONSE (EXTENDED):

Sample response (inbox folder):

{
"result": {
"messages": [
{
"UpdatedInDB": "2018-07-18 14:06:06",
"ReceivingDateTime": "2018-07-17 15:04:04",
"Text": "005400650073007400200031",
"SenderNumber": "+48123456789",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "+48790998250",
"Class": "-1",
"TextDecoded": "Test 1",
"ID": "124",
"RecipientID": "smseagle1",
"Processed": "t",
"id_folder": "1",
"readed": "true",
"oid": "",
"Status": "0"
},
{
"UpdatedInDB": "2018-07-18 14:06:06",
"ReceivingDateTime": "2018-07-17 15:04:10",
"Text": "005400650073007400200032",

79 | SMSEagle NXS-9750 | User’s Manual

 "SenderNumber": "+48123456788",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "+48790998250",
"Class": "-1",
"TextDecoded": "Test 2",
"ID": "125",
"RecipientID": "smseagle1",
"Processed": "t",
"id_folder": "1",
"readed": "true",
"oid": "5208facc-5912-4d21-8d31-7f830cf8f24e",
"Status": "0"
},
{
"UpdatedInDB": "2018-07-18 14:06:06",
"ReceivingDateTime": "2018-07-17 15:05:49",
"Text":
"004C006F00720065006D00200069007000730075006D00200064006F006C006F0072002000
730069007400200061006D00650074002C00200063006F006E0073006500630074006500740
0750072002000610064006900700069007300630069006E006700200065006C00690074002E
002000430072006100730020006600650072006D0065006E00740075006D00200075006C006
C0061006D0063006F007200700065007200200065006700650073007400610073002E002000
4E0075006C006C006100200070006C006100630065007200610074002000660069006E00690
0620075007300200064006F006C006F0072002C0020006D0061006C00650073007500610064
006100200076006100720069007500730020006C006900670075006C0061002000680065006
E006400720065",
"SenderNumber": "+48123456787",
"Coding": "Default_No_Compression",
"UDH": "050003590301",
"SMSCNumber": "+48790998250",
"Class": "-1",
"TextDecoded": "Lorem ipsum dolor sit amet, consectetur
adipiscing elit. Cras fermentum ullamcorper egestas. Nulla placerat finibus
dolor, malesuada varius ligula hendrerit sed. Nullam nisl sapien, molestie
rhoncus orci vel, viverra luctus ipsum. Praesent maximus luctus orci.
Vestibulum lacus dui, vestibulum ac aliquam eget, ultrices et mi. In ac
felis urna. Phasellus eget leo a leo congue ultricies. Donec tincidunt
volutpat arcu a commodo",
"ID": "126",
"RecipientID": "smseagle1",
"Processed": "t",
"id_folder": "1",
"readed": "true",
"oid": "",
"Status": "0"
}
],
"status": "ok"
}
}

Sample response (sentitems folder):

{
"result": {
"messages": [
{
"UpdatedInDB": "2018-06-07 11:29:56",
"InsertIntoDB": "2018-06-07 11:29:43",
"SendingDateTime": "2018-06-07 11:29:56",
"DeliveryDateTime": "2018-06-07 11:30:05",
"Text": "0074006500730074",

80 | SMSEagle NXS-9750 | User’s Manual

 "DestinationNumber": "+48123456789",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "+48501200777",
"Class": "-1",
"TextDecoded": "test",
"ID": "456",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "DeliveryOK",
"StatusError": "-1",
"TPMR": "116",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "-1"
},
{
"UpdatedInDB": "2018-07-13 11:40:45",
"InsertIntoDB": "2018-07-13 11:40:40",
"SendingDateTime": "2018-07-13 11:40:45",
"DeliveryDateTime": null,
"Text": "",
"DestinationNumber": "*101#",
"Coding": "8bit",
"UDH": "",
"SMSCNumber": "+48501200777",
"Class": "127",
"TextDecoded": "",
"ID": "525",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "SendingOK",
"StatusError": "-1",
"TPMR": "-1",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "-1"
},
{
"UpdatedInDB": "2018-07-18 14:25:41",
"InsertIntoDB": "2018-07-18 14:25:23",
"SendingDateTime": "2018-07-18 14:25:28",
"DeliveryDateTime": "2018-07-18 14:25:28",
"Text": "0054006500730074002000740065007300740031",
"DestinationNumber": "+48123456788",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "+48601000310",
"Class": "-1",
"TextDecoded": "Test test1",
"ID": "574",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "DeliveryOK",
"StatusError": "0",
"TPMR": "84",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "-1"
},
{

81 | SMSEagle NXS-9750 | User’s Manual

 "UpdatedInDB": "2018-07-18 14:27:13",
"InsertIntoDB": "2018-07-18 14:27:03",
"SendingDateTime": "2018-07-18 14:27:13",
"DeliveryDateTime": null,
"Text":
"00540065007300740020007700690074006800200075006E00690063006F00640065002000
65006E0063006F00640069006E0067003A00200105014200F30119017A0107",
"DestinationNumber": "123456788",
"Coding": "Unicode_No_Compression",
"UDH": "",
"SMSCNumber": "+48601000310",
"Class": "-1",
"TextDecoded": "Test with unicode encoding: ąłóęźć",
"ID": "576",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "SendingOK",
"StatusError": "-1",
"TPMR": "86",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "-1"
},
{
"UpdatedInDB": "2018-07-18 14:27:36",
"InsertIntoDB": "2018-07-18 14:27:32",
"SendingDateTime": "2018-07-18 14:27:36",
"DeliveryDateTime": null,
"Text":
"00540065007300740020006F006600200066006C0061007300680020006D00650073007300
6100670065",
"DestinationNumber": "123456788",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "+48601000310",
"Class": "0",
"TextDecoded": "Test of flash message",
"ID": "577",
"SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "SendingOK",
"StatusError": "-1",
"TPMR": "87",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "-1"
},
{
"UpdatedInDB": "2018-07-18 14:29:29",
"InsertIntoDB": "2018-07-18 14:28:46",
"SendingDateTime": "2018-07-18 14:29:29",
"DeliveryDateTime": null,
"Text":
"0054006500730074002000770069007400680020006200610064002000700068006F006E00
650020006E0075006D006200650072",
"DestinationNumber": "11",
"Coding": "Default_No_Compression",
"UDH": "",
"SMSCNumber": "",
"Class": "-1",
"TextDecoded": "Test with bad phone number",
"ID": "578",

82 | SMSEagle NXS-9750 | User’s Manual

 "SenderID": "smseagle1",
"SequencePosition": "1",
"Status": "SendingError",
"StatusError": "-1",
"TPMR": "-1",
"RelativeValidity": "255",
"CreatorID": "admin",
"id_folder": "3",
"StatusCode": "21"
}
],
"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"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":" Wrong or missing >>udh<< parameter
","status":"error"}}

FIELD DESCRIPTION OF RESPONSE DATA – INBOX FOLDER:

Field Data type Description

UpdatedInDB timestamp when somebody (software, user) updated the
message content or state
ReceivingDateTime timestamp when SMS was received
Text text SMS text encoded using hex values
SenderNumber character varying (30) SMS sender number
Coding character varying (255) SMS text coding. Possible values:
‘Default_No_Compression’, ‘Unicode_No_Compression’,
‘8bit’,
‘Default_Compression’,
‘Unicode_Compression’
UDH text User Data Header encoded using hex values
SMSCNumber character varying (20) SMSC number
Class integer SMS class (0 is flash SMS, -1 is normal SMS, 127 is
USSD)
TextDecoded text decoded SMS text
ID serial 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:
1 Inbox

83 | SMSEagle NXS-9750 | User’s Manual

 5 Trash
11… Custom folder
readed text whether SMS was read in GUI or via API
oid character varying (36) user-defined unique ID that is assigned to a message-
recipient pair. The oid uniquely identifies a message
sent to a particular recipient (particular phone
number).
More information: see send_sms method description
Status integer Status of incoming message. Currently only used for
USSD messages with following meaning:
1 Unknown status.
2 No action is needed, maybe network initiated USSD.
3 Reply is expected.
4 USSD dialog terminated.
5 Another client replied.
6 Operation not supported.
7 Network timeout.

FIELD DESCRIPTION OF RESPONSE DATA – SENTITEMS FOLDER:

Field Data type Description

UpdatedInDB timestamp when somebody (software, user) updated the
message content or state
InsertIntoDB timestamp when message was inserted into database
SendingDateTime timestamp when message has been sent
DeliveryDateTime timestamp time of receiving a delivery report (if it has been
enabled). Null if delivery report was not received.
Text text SMS text encoded using hex values
DestinationNumber character varying (30) destination number for SMS
Coding character varying (255) SMS text coding. Possible values:
‘Default_No_Compression’, ‘Unicode_No_Compression’,
‘8bit’,
‘Default_Compression’,
‘Unicode_Compression’
UDH text User Data Header encoded using hex values
SMSCNumber character varying (20) number of SMSC, which sent SMS
Class integer SMS class (0 is flash SMS, -1 is normal SMS, 127 is
USSD)
TextDecoded text decoded SMS text
ID serial 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
Message has been sent, waiting for delivery report

84 | SMSEagle NXS-9750 | User’s Manual

 SendingOKNoReport
Message has been sent without asking for delivery
report
SendingError
Sending has failed
DeliveryOK
Delivery report arrived and reported success
DeliveryFailed
Delivery report arrived and reports failure
DeliveryPending
Delivery report announced pending deliver
DeliveryUnknown
Delivery report reported unknown status
Error
Some other error happened during sending

Notice: some cellular operators return “SendingOK” status

instead of “DeliveryOK” for correctly delivered SMS. If you want
to check for delivery status, please verify what values you
receive from your operator or instead use the field
DeliveryDateTime.
StatusError integer Status of delivery from delivery report message, codes
are defined in GSM specification 03.40 section
9.2.3.15 (TP-Status)
TPMR integer The Message Reference field (TP-MR) as defined in
GSM 03.40
RelativeValidity integer SMS relative validity (TP-VP) encoded as defined in
GSM 03.40
CreatorID text username that created the SMS message
id_folder integer identification of storage folder. Possible values:
3 Sent items
5 Trash
11… Custom folder
StatusCode integer CMS status code (also known as CMS ERROR) received
from cellular network.
- 1 No CMS Error
> -1 CMS Error occurred. CMS error number is saved in
this field.

13. Delete SMS: HTTP GET method

HTTP GET METHOD:
https://url-of-smseagle/http_api/delete_sms

Parameter Description

85 | SMSEagle NXS-9750 | User’s Manual

 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

idfrom minimal id of message

idto maximal id of message

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
Delete message with id=1234 from inbox:
https://url-of-smseagle/http_api/delete_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox&idfrom=1234&idto
=1234

Delete messages with id 1234 – 1250 from inbox:

https://url-of-smseagle/http_api/delete_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=inbox&idfrom=1234&idto
=1250

Delete all messages from outbox:

https://url-of-smseagle/http_api/delete_sms?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&folder=outbox&idfrom=1&idto=9
99999999

RESPONSE:
Response: OK
Response (when delete operation was not successful): Error
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when delete operation was not successful):

<xml>
<status>error</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

86 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong access token):
<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

14. Delete SMS: JSONRPC method

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

folder one of the following: inbox, outbox, sentitems

idfrom minimal id of message

idto maximal id of message

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
Delete message with id=1234 from inbox:
{"method":"sms.delete_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"folder":"inbox
","idfrom":"1234""idto":"1234"}}

Delete messages with id 1234 – 1250 from inbox:

{"method":"sms.delete_sms",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"folder":"inbox
","idfrom":"1234","idto":"1250"}}

Delete all messages from outbox:

{"method":"sms.delete_sms",
"params":{"access_token"=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq","folder":"outbox
","idfrom":"1","idto":"999999999"}}

RESPONSE:
Response: {"result": "OK"}
Response (when delete operation was not successful): {"result": "Error"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when delete operation was not successful):

{"result":{"status":"error"}}

87 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong logindata):
{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

15. Get outgoing queue length: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/get_queue_length

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

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/get_queue_length?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq

RESPONSE:
Response: [number of messages in database that wait to be processed by GSM-modem]
Sample response: 7
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong parameters

RESPONSE (XML):
Response:
<xml>
<queue_length>
[number of messages in database that wait to be processed by GSM-modem]
</queue_length >
<status>ok</status>
</xml>

Sample response:
<xml>
<queue_length>7</queue_length >
<status>ok</status>
</xml>

Response (when wrong logindata):

88 | SMSEagle NXS-9750 | User’s Manual

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<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>

16. Get outgoing queue length: JSONRPC method

HTTP POST METHOD CALL:

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

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

BODY:
{"method":"sms.get_queue_length",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

RESPONSE:
Response: {"result": [number of messages in database that wait to be
processed by GSM-modem]}
Sample response: {"result":7}
Response: {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response: {"result": "Wrong parameters"}

RESPONSE (EXTENDED):
Response:

89 | SMSEagle NXS-9750 | User’s Manual

{"result":{"queue_length":[number of messages in database that wait to be
processed by GSM-modem],"status":"ok"}}

Sample response: {"result": {"queue_length":"419","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong parameters","status":"error"}}

17. Get inbox length: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/get_inbox_length

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

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/get_inbox_length?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq

RESPONSE:
Response: [number of messages in database Inbox folder]
Sample response: 3
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong parameters

RESPONSE (XML):
Response:
<xml>
<queue_length>
[number of messages in database Inbox folder]
</queue_length>
<status>ok</status>
</xml>

90 | SMSEagle NXS-9750 | User’s Manual

Sample response:
<xml>
<inbox_length>3</inbox_length>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<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>

18. Get inbox length: JSONRPC method

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

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"sms.get_inbox_length",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

RESPONSE:
Response: {"result": "[number of messages in database Inbox folder]"}

91 | SMSEagle NXS-9750 | User’s Manual

Sample response: 3
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters): {"result": "Wrong parameters"}

RESPONSE (EXTENDED):
Response:
{"result":{"inbox_length":[number of messages in database Inbox
folder],"status":"ok"}}

Sample response: {"result": {"inbox_length":"3","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong parameters","status":"error"}}

19. Get sentitems length: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/get_inbox_length

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

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/get_sentitems_length?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq

RESPONSE:
Response: [number of messages in database Sentitems folder]
Sample response: 21
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong parameters

92 | SMSEagle NXS-9750 | User’s Manual

RESPONSE (XML):
Response:
<xml>
<sentitems_length>
[number of messages in database Inbox folder]
</sentitems_length>
<status>ok</status>
</xml>

Sample response:
<xml>
<sentitems_length>21</sentitems_length>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<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>

20. Get sentitems length: JSONRPC method

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

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

93 | SMSEagle NXS-9750 | User’s Manual

EXAMPLES:
{"method":"sms.get_sentitems_length",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

RESPONSE:
Response: {"result": "[number of messages in database Sentitems folder]"}
Sample response: {"result": "21"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters): {"result": "Wrong parameters"}

RESPONSE (EXTENDED):
Response:
{"result":{"sentitems_length":[number of messages in database Sentitems
folder],"status":"ok"}}

Sample response: {"result": {"sentitems_length":"21","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong parameters","status":"error"}}

21. Get GSM/3G signal strength: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/get_gsmsignal

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 (optional parameter) modem number to be queried (default = 1). Used only in
multimodem devices

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/get_gsmsignal?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&modem_no=1

94 | SMSEagle NXS-9750 | User’s Manual

RESPONSE:
Response: GSM/3G signal strength in percent (values between 0-100). If 3G modem is disconnected from
GSM/3G network, method returns -1
Sample response: 74
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong parameters

RESPONSE (XML):
Response:
<xml>
<signal_strength>
[GSM signal strength in percent (values between 0-100)]
</signal_strength>
<status>ok</status>
</xml>

Sample response:
<xml>
<signal_strength>74</signal_strength>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<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>

95 | SMSEagle NXS-9750 | User’s Manual

22. Get GSM/3G signal strength: JSONRPC method

HTTP POST METHOD CALL:

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

modem_no (optional parameter) modem number to be queried (default = 1). Used only in
multimodem devices

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

BODY:
{"method":"signal.get_gsmsignal",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

RESPONSE:
Response: {"result": GSM/3G signal strength in percent: values between 0-100.
If 3G modem is disconnected from GSM/3G network, method returns -1 }
Sample response: {"result":7}
Response: {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response: {"result": "Wrong parameters"}

RESPONSE (EXTENDED):
Response:
{"result":{"signal_strength":[number of messages in database Sentitems
folder],"status":"ok"}}

Sample response: {"result": {"signal_strength":"7","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

96 | SMSEagle NXS-9750 | User’s Manual

23. Phonebook group create: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/group_create

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 (optional parameter) 0 = private group, 1 = public group

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/group_create?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&groupname=myusers&public=1

RESPONSE:
Response: OK; ID=[ID of created group]
Sample response: OK; ID=5
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong or missing >>groupname<< parameter

RESPONSE (XML):
Response:
<xml>
<group_id>[ID of created group]</group_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<group_id>5</group_id>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

97 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong access token):
<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>groupname<< parameter</error_text>
<status>error</status>
</xml>

24. Phonebook group create: JSONRPC method

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

groupname name for the created group

public (optional parameter) 0 = private group, 1 = public group

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"phonebook.group_create",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"groupname":"my
users","public":"1"}}

RESPONSE:
Response: {"result": "OK; ID=[ID of created group]"}
Sample response: {"result": "OK; ID=5"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters): {"result": "Wrong or missing >>groupname<<
parameter"}

RESPONSE (EXTENDED):
Response:
{"result": {"group_id":"[ID of created group]","status":"ok"}}

Sample response: {"result": {"group_id":"748","status":"ok"}}

98 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong logindata):
{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong parameters","status":"error"}}

25. Phonebook group read: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/group_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)

pass your password to login to SMSEagle

public (optional parameter) 0 = private group (default value), 1 = public group

uid (optional parameter) id of user who created the group

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/group_read?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&public=1&uid=12

RESPONSE:
Sample response: link
Response (when no data): No data to display
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>uid<< parameter
Wrong or missing >>public<< parameter

RESPONSE (XML):
Sample response:

<xml>
<groups>
<item>
<Name>private</Name>
<ID>2</ID>
<id_user>2</id_user>

99 | SMSEagle NXS-9750 | User’s Manual

<is_public>true</is_public>
</item>
<item>
<Name>Everyone</Name>
<ID>3</ID>
<id_user>1</id_user>
<is_public>true</is_public>
</item>
<item>
<Name>work</Name>
<ID>4</ID>
<id_user>1</id_user>
<is_public>true</is_public>
</item></groups>
<status>ok</status>
</xml>

Response (when no data):

<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>uid<< parameter</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>public<< parameter</error_text>
<status>error</status>
</xml>

100 | SMSEagle NXS-9750 | User’s Manual

26. Phonebook group read: JSONRPC method

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

public (optional parameter) 0 = private group (default value), 1 = public group

uid (optional parameter) id of user who created the group

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"phonebook.group_read",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"public":"1","u
id":"12"}}

RESPONSE:
Sample response:

{"result":[
{"Name":"private","ID":"2","id_user":"1","is_public":"true"},
{"Name":"Everyone","ID":"3","id_user":"1","is_public":"true"},
{"Name":"work","ID":"4","id_user":"2","is_public":"true"}
]}
Response (when no data): {"result": "No data to display"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>uid<< parameter"}
{"result": "Wrong or missing >>public<< parameter"}

RESPONSE (EXTENDED):
Sample response:
{"result":[ {"groups":[
{"Name":"private","ID":"2","id_user":"1","is_public":"true"},
{"Name":"Everyone","ID":"3","id_user":"1","is_public":"true"},
{"Name":"work","ID":"4","id_user":"2","is_public":"true"}
],"status":"ok"}}

Response (when no data):

{"result": {"error_text":" No data to display","status":"error"}}

101 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong logindata):
{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>uid<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>public<<

parameter","status":"error"}}

27. Phonebook group update: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/group_update

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

public (optional parameter) 0 = private group, 1 = public group

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/group_update?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&groupname=myusers&
public=1

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>groupname<< parameter
Wrong or missing >>group_id<< parameter
Response (when group_id is wrong): Group with the given id does not exists

102 | SMSEagle NXS-9750 | User’s Manual

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

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>

28. Phonebook group update: JSONRPC method

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

103 | SMSEagle NXS-9750 | User’s Manual

 group_id id of existing group

groupname name for the group

public (optional parameter) 0 = private group, 1 = public group

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"phonebook.group_update",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"group_id":"2",
"groupname":"myusers","public":"1"}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>groupname<< parameter"}
{"result": "Wrong or missing >>group_id<< parameter"}
Response (when group_id is wrong): {"result": "Group with the given id does not
exists"}

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>groupname<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>group_id<<

parameter","status":"error"}}

Response (when group_id is wrong):

{"result": {"error_text":"Group with the given id does not
exists","status":"error"}}

29. Phonebook group delete: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/group_delete

Parameter Description

104 | SMSEagle NXS-9750 | User’s Manual

 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

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/group_delete?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&groupname=myusers

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>groupname<< parameter
Wrong or missing >>group_id<< parameter
Response (when group_id is wrong): Group with the given id and name does not exist

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>groupname<< parameter</error_text>
<status>error</status>
</xml>

105 | SMSEagle NXS-9750 | User’s Manual

<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>

30. Phonebook group delete: JSONRPC method

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

group_id id of existing group

groupname name of existing group

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"phonebook.group_delete",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"group_id":"2",
"groupname":"myusers"}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>groupname<< parameter"}
{"result": "Wrong or missing >>group_id<< parameter"}
Response (when group_id is wrong): {"result": "Group with the given id and name does
not exist"}

106 | SMSEagle NXS-9750 | User’s Manual

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>groupname<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>group_id<<

parameter","status":"error"}}

Response (when group_id is wrong):

{"result": {"error_text":"Group with the given id does not
exists","status":"error"}}

31. Phonebook group add contact: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/group_addcontact

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 (or id’s separated with comma)

contact_id id of contact. The contact will be added to the group

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/group_addcontact?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&contact_id=1

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>group_id<< parameter
Wrong or missing >>contact_id<< parameter
Response (when id is wrong):

107 | SMSEagle NXS-9750 | User’s Manual

Group with the given id does not exists
Contact with the given id does not exists

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

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>

<xml>
<error_text>Contact with the given id does not exists</error_text>
<status>error</status>
</xml>

108 | SMSEagle NXS-9750 | User’s Manual

32. Phonebook group add contact: JSONRPC method

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

group_id id of existing group (or id’s separated with comma)

contact_id id of contact. The contact will be added to the group

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"phonebook.group_addcontact",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"group_id":"2",
"contact_id":"1"}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>group_id<< parameter"}
{"result": "Wrong or missing >>contact_id<< parameter"}
Response (when id is wrong):
{"result": "Group with the given id does not exists"}
{"result": "Contact with the given id does not exists"}

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>group_id<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>contact_id<<

parameter","status":"error"}}

109 | SMSEagle NXS-9750 | User’s Manual

Response (when id is wrong):
{"result": {"error_text":"Group with the given id does not
exists","status":"error"}}

{"result": {"error_text":"Contact with the given id does not

exists","status":"error"}}

33. Phonebook group remove contact: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/group_removecontact

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 (or id’s separated with comma)

contact_id id of contact. The contact will be removed from the group

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/group_removecontact?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=2&contact_id=1

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>group_id<< parameter
Wrong or missing >>contact_id<< parameter
Response (when id is wrong):
Group with the given id does not exists
Contact with the given id does not exists

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

110 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

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>

<xml>
<error_text>Contact with the given id does not exists</error_text>
<status>error</status>
</xml>

34. Phonebook group remove contact: JSONRPC method

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

group_id id of existing group (or id’s separated with comma)

111 | SMSEagle NXS-9750 | User’s Manual

 contact_id id of contact. The contact will be removed from the group

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"phonebook.group_removecontact",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"group_id":"2",
"contact_id":"1"}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>group_id<< parameter"}
{"result": "Wrong or missing >>contact_id<< parameter"}
Response (when id is wrong):
{"result": "Group with the given id does not exists"}
{"result": "Contact with the given id does not exists"}

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>group_id<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>contact_id<<

parameter","status":"error"}}

Response (when id is wrong):

{"result": {"error_text":"Group with the given id does not
exists","status":"error"}}

{"result": {"error_text":"Contact with the given id does not

exists","status":"error"}}

35. Phonebook contact create: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/contact_create

112 | SMSEagle NXS-9750 | 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

contactname name for the created contact

number telephone number for the created contact

public (optional parameter) 0 = private contact, 1 = public contact (default value)

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/contact_create?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contactname=johndoe&number=12
345678&public=1

RESPONSE:
Response: OK; ID=[ID of created contact]
Sample response: OK; ID=2
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>contactname<< parameter
Wrong or missing >>number<< parameter

RESPONSE (XML):
Response:
<xml>
<contact_id>[ID of created contact]</contact_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<contact_id>2</contact_id>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

113 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong access token):
<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>contactname<< parameter</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>number<< parameter</error_text>
<status>error</status>
</xml>

36. Phonebook contact create: JSONRPC method

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

contactname name for the created contact

number telephone number for the created contact

public (optional parameter) 0 = private contact 1 = public contact (default value)

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"phonebook.contact_create",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"contactname":"
johndoe","number":"12345678","public":"1"}}

RESPONSE:
Response: {"result": "OK; ID=[ID of created contact]"}
Sample response: {"result": "OK; ID=2"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}

114 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong parameters):
{"result": "Wrong or missing >>contactname<< parameter"}
{"result": "Wrong or missing >>number<< parameter"}

RESPONSE (EXTENDED):
Response:
{"result": {"contact_id":"[ID of created contact]","status":"ok"}}

Sample response: {"result": {"contact_id":"2","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>contactname<<
parameter"},"status":"error"}}

{"result": {"error_text":"Wrong or missing >>number<<

parameter","status":"error"}}

37. Phonebook contact read: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/contact_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)

pass your password to login to SMSEagle

public (optional parameter) 0 = private contacts (default value), 1 = public contacts

uid (optional parameter) id of user who created the contact

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/contact_read?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&public=1&uid=12

RESPONSE:
Sample response: link
Response (when no data): No data to display
Response (when wrong logindata): Invalid login or password

115 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>uid<< parameter
Wrong or missing >>public<< parameter

RESPONSE (XML):
Sample response:

<xml>
<contacts>
<item>
<ID>2</ID>
<GroupID>-1</GroupID>
<Name>John Doe</Name>
<Number>123123123</Number>
<id_user>1</id_user>
<is_public>true</is_public>
</item>
<item>
<ID>4</ID>
<GroupID>-1</GroupID>
<Name>Jan Nowak</Name>
<Number>4215456456</Number>
<id_user>1</id_user>
<is_public>true</is_public>
</item>
<item>
<ID>5</ID>
<GroupID>-1</GroupID>
<Name>Andy</Name>
<Number>+441234155931</Number>
<id_user>1</id_user>
<is_public>true</is_public>
</item>
</contacts>
<status>ok</status>
</xml>

Response (when no data):

<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

Response (when wrong logindata):

<xml>

116 | SMSEagle NXS-9750 | User’s Manual

 <error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>uid<< parameter</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>public<< parameter</error_text>
<status>error</status>
</xml>

38. Phonebook contact read: JSONRPC method

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

public (optional parameter) 0 = private contacts (default value), 1 = public contacts

uid (optional parameter) id of user who created the contact

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"phonebook.contact_read",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"public":"1","u
id":"12"}}

RESPONSE:
Sample response:

117 | SMSEagle NXS-9750 | User’s Manual

{"result":[
{"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"
}
]}

Response (when no data): {"result": "No data to display"}

Response (when wrong logindata): {"result": "Invalid login or password"}

Response (when wrong access token): {"result": "Invalid access token"}

Response (when wrong parameters):

{"result": "Wrong or missing >>uid<< parameter"}
{"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"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>uid<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>public<<

parameter","status":"error"}}

118 | SMSEagle NXS-9750 | User’s Manual

39. Phonebook contact update: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/contact_update

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

number phone number for the contact

public (optional parameter) 0 = private group, 1 = public group

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/contact_update?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contact_id=4&contactname=john
lord&number=123456789&public=1

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>contactname<< parameter
Wrong or missing >>contact_id<< parameter
Wrong or missing >>number<< parameter
Response (when contact_id is wrong): Contact with the given id does not exists

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>

119 | SMSEagle NXS-9750 | User’s Manual

 <status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>contactname<< parameter</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>

<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

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

number phone number for the contact

public (optional parameter) 0 = private group, 1 = public group

120 | SMSEagle NXS-9750 | User’s Manual

 responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"phonebook.contact_update",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"contact_id":"4
","contactname":"johnlord","number":"123456789","public":"1"}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>contactname<< parameter"}
{"result": "Wrong or missing >>contact_id<< parameter"}
{"result": "Wrong or missing >>number<< parameter"}
Response (when contact_id is wrong): {"result": "Contact with the given id does not
exists"}

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>contactname<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>contact_id<<

parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>number<<

parameter","status":"error"}}

Response (when contact_id is wrong):

{"result": {"error_text":"Contact with the given id does not
exists","status":"error"}}

41. Phonebook contact delete: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/contact_delete

Parameter Description

121 | SMSEagle NXS-9750 | User’s Manual

 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

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/contact_delete?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&contact_id=4&contactname=john
lord

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>contactname<< parameter
Wrong or missing >>contact_id<< parameter
Response (when contact_id is wrong): Contact with the given id and name does not exists

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>

122 | SMSEagle NXS-9750 | User’s Manual

 <error_text>Wrong or missing >>contactname<< parameter</error_text>
<status>error</status>
</xml>

<xml>
<error_text>Wrong or missing >>contact_id<< parameter</error_text>
<status>error</status>
</xml>

Response (when contact_id is wrong):

<xml>
<error_text>Contact with the given id and name does not exists </error_text>
<status>error</status>
</xml>

42. Phonebook contact delete: JSONRPC method

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

contact_id id of existing contact

contactname name of existing contact

responsetype (optional parameter) simple = format response as simple object with one result
field (default), extended = format response as extended JSON object

EXAMPLES:
{"method":"phonebook.contact_delete",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"contact_id":"4
","contactname":"johnlord"}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>contactname<< parameter"}
{"result": "Wrong or missing >>contact_id<< parameter"}
Response (when contact_id is wrong): {"result": "Contact with the given id and name
does not exists"}

123 | SMSEagle NXS-9750 | User’s Manual

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>contactname<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>contact_id<<

parameter","status":"error"}}

Response (when contact_id is wrong):

{"result": {"error_text":"Contact with the given id and name does not
exists","status":"error"}}

43. Call with termination: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/call_with_termination

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

to phone numer to call

duration connection duration (in seconds)

modem_no (optional parameter) modem number (only for multimodem devices)

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/call_with_termination?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&to=123456789&duration=5

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token

124 | SMSEagle NXS-9750 | User’s Manual

Response (when modem doesn’t support voice calls): This modem doesn't support voice calls
Response (when wrong parameters):
Wrong or missing >>to<< parameter
Wrong or missing >>duration<< parameter
Response (when modem_no is wrong): Modem not recognized

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>duration<< parameter</error_text>
<status>error</status>
</xml>

Response (when modem doesn’t support voice calls):

<xml>
<error_text>This modem doesn't support voice calls</error_text>
<status>error</status>
</xml>

Response (when modem_no is wrong):

<xml>
<error_text> Modem not recognized </error_text>
<status>error</status>
</xml>

Important notice: this method is available only for devices with 3G voice modem

125 | SMSEagle NXS-9750 | User’s Manual

44. Call with termination: JSONRPC method

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

to phone numer to call

duration connection duration (in seconds)

modem_no (optional parameter) calling modem number (only for multimodem devices)

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
{"method":"phone.call_with_termination",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"to":"123456789
", "duration":"5"}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when modem doesn’t support voice calls): {"result": "This modem doesn't support
voice calls"}
Response (when wrong parameters):
{"result": "Wrong or missing >>to<< parameter"}
{"result": "Wrong or missing >>duration<< parameter"}
Response (when modem_no is wrong): {"result": " Modem not recognized"}

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when modem doesn’t support voice calls):

{"result": {"error_text":"This modem doesn't support voice
calls","status":"error"}}

126 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong parameters):
{"result": {"error_text":"Wrong or missing >>to<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>duration<<

parameter","status":"error"}}

Response (when modem_no is wrong):

{"result": {"error_text":"Modem not recognized","status":"error"}}

Important notice: this method is available only for devices with 3G voice modem

45. Phonebook shift create: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/shift_create

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 0 = disabled, 1 = enabled

(mon-sun)_from shift start hour for each day of week

(mon-sun)_to shift end hour for each day of week

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/shift_create?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&name=myshift&mon_from=08:00&m
on_to=16:00&wed_from=09:00&wed_to=20:00&enabled=1

RESPONSE:
Response: OK; ID=[ID of created shift]
Sample response: OK; ID=5
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters): Wrong or missing >>name<< parameter

RESPONSE (XML):
Response:
<xml>

127 | SMSEagle NXS-9750 | User’s Manual

 <shift_id>[ID of created shift]</shift_id>
<status>ok</status>
</xml>

Sample response:
<xml>
<shift_id>5</shift_id>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>name<< parameter</error_text>
<status>error</status>
</xml>

46. Phonebook shift create: JSONRPC method

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

name name for the created shift

enabled 0 = disabled, 1 = enabled

(mon-sun)_from shift start hour for each day of week

(mon-sun)_to shift end hour for each day of week

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

128 | SMSEagle NXS-9750 | User’s Manual

EXAMPLES:
{"method":"phonebook.shift_create",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"name":"myshift
","mon_from":"08:00","mon_to":"16:00","wed_from":"09:00","wed_to":"20:00","
enabled":"1"}}

RESPONSE:
Response: {"result": "OK; ID=[ID of created shift]"}
Sample response: {"result": "OK; ID=5"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters): {"result": "Wrong or missing >>name<< parameter"}

RESPONSE (EXTENDED):
Response:
{"result": {"shift_id":"[ID of created shift]","status":"ok"}}

Sample response: {"result": {"shift_id":"748","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":" Wrong or missing >>name<< parameter
","status":"error"}}

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)

pass your password to login to 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

129 | SMSEagle NXS-9750 | User’s Manual

EXAMPLES:
https://url-of-smseagle/http_api/shift_read?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&name=myshift

RESPONSE:
Sample response: link
Response (when no data): No data to display
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong >>shift_id<< parameter

RESPONSE (XML):
Sample response:

<xml>
<shifts>
<shift>
<id_shift>62</id_shift>
<name>myshift</name>
<mon_from>08:00</mon_from>
<mon_to>16:00</mon_to>
<tue_from/>
<tue_to/>
<wed_from>09:00</wed_from>
<wed_to>20:00</wed_to>
<thu_from/>
<thu_to/>
<fri_from/>
<fri_to/>
<sat_from/>
<sat_to/>
<sun_from/>
<sun_to/>
<enabled>true</enabled>
</shift>
</shifts>
<status>ok</status>
</xml>
Response (when no data):
<xml>
<error_text>No data to display</error_text>
<status>error</status>
</xml>

130 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong logindata):
<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text> Wrong >>id<< parameter</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text> Wrong >>enabled<< parameter</error_text>
<status>error</status>
</xml>

48. Phonebook shift read: JSONRPC method

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

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

EXAMPLES:
{"method":"phonebook.shift_read",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"name":"myshift
"}}

131 | SMSEagle NXS-9750 | User’s Manual

RESPONSE:
Sample response:

{
"result": [
{
"id_shift": "62",
"name": "myshift",
"mon_from": "08:00",
"mon_to": "16:00",
"tue_from": null,
"tue_to": null,
"wed_from": "09:00",
"wed_to": "20:00",
"thu_from": null,
"thu_to": null,
"fri_from": null,
"fri_to": null,
"sat_from": null,
"sat_to": null,
"sun_from": null,
"sun_to": null,
"enabled": "true"
}
]
}
Response (when no data): {"result": "No data to display"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong >> enabled<< parameter"}
{"result": "Wrong >>shift_id<< parameter"}

RESPONSE (EXTENDED):
Sample response:
{
"result": {
"shifts": [
{
"id_shift": "62",
"name": "myshift",
"mon_from": "08:00",
"mon_to": "16:00",
"tue_from": null,
"tue_to": null,
"wed_from": "09:00",
"wed_to": "20:00",
"thu_from": null,
"thu_to": null,
"fri_from": null,
"fri_to": null,
"sat_from": null,
"sat_to": null,

132 | SMSEagle NXS-9750 | User’s Manual

 "sun_from": null,
"sun_to": null,
"enabled": "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"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":" Wrong >> enabled<< parameter ","status":"error"}}

{"result": {"error_text":" Wrong >> shift_id<< parameter

","status":"error"}}

49. Phonebook shift update: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/shift_update

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

enabled 0 = disabled, 1 = enabled

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/shift_update?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&shift_id=24&name=updatedshift
&enabled=1

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password

133 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>name<< parameter
Wrong or missing >>shift_id<< parameter
Response (when shift_id is wrong): Shift with the given id does not exists

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

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>
</xml>

50. Phonebook shift update: JSONRPC method

HTTP POST METHOD:

https://url-of-smseagle/jsonrpc/sms

134 | SMSEagle NXS-9750 | 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

enabled 0 = disabled, 1 = enabled

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
{"method":"phonebook.shift_update",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"shift_id":"24"
,"name":"updatedshift","enabled":"1"}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>name<< parameter"}
{"result": "Wrong or missing >>shift_id<< parameter"}
Response (when shift_id is wrong): {"result": "Shift with the given id does not
exists"}

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>name<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>shift_id<<

parameter","status":"error"}}

Response (when shift_id is wrong):

{"result": {"error_text":"Shift with the given id does not
exists","status":"error"}}

135 | SMSEagle NXS-9750 | User’s Manual

51. Phonebook shift delete: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/shift_delete

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
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/shift_delete?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&shift_id=24

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>shift_id<< parameter
Response (when shift_id is wrong): Shift with the given id does not exist

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

136 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong parameters):
<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 the given id does not exists</error_text>
<status>error</status>
</xml>

52. Phonebook shift delete: JSONRPC method

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

shift_id id of existing shift

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
{"method":"phonebook.shift_delete",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"shift_id":"24"
}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>shift_id<< parameter"}
Response (when shift_id is wrong): {"result": "Shift with the given id does not
exist"}

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

137 | SMSEagle NXS-9750 | User’s Manual

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>shift_id<<
parameter","status":"error"}}

Response (when shift_id is wrong):

{"result": {"error_text":"Shift with the given id does not
exists","status":"error"}}

53. Phonebook shift add contact: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/shift_addcontact

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 (or id’s separated with comma)

contact_id id of contact. The contact will be added to the shift

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/shift_addcontact?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&shift_id=2&contact_id=1

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>shift_id<< parameter
Wrong or missing >>contact_id<< parameter
Response (when id is wrong):
Shift with the given id does not exists
Contact with the given id does not exists

RESPONSE (XML):

138 | SMSEagle NXS-9750 | User’s Manual

Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>shift_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>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>

54. Phonebook shift add contact: JSONRPC method

HTTP POST METHOD:

https://url-of-smseagle/jsonrpc/sms

Parameter Description

access_token authentication access token (see details in point API Authentication)

139 | SMSEagle NXS-9750 | User’s Manual

 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. The contact will be added to the shift

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
{"method":"phonebook.shift_addcontact",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"shift_id":"24"
,"contact_id":"1"}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>shift_id<< parameter"}
{"result": "Wrong or missing >>contact_id<< parameter"}
Response (when id is wrong):
{"result": "Shift with the given id does not exists"}
{"result": "Contact with the given id does not exists"}

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>shift_id<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>contact_id<<

parameter","status":"error"}}

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"}}

140 | SMSEagle NXS-9750 | User’s Manual

55. Phonebook shift remove contact: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/shift_removecontact

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 (or id’s separated with comma)

contact_id id of contact. The contact will be added to the shift

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/shift_removecontact?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&shift_id=24&contact_id=1

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when wrong parameters):
Wrong or missing >>shift_id<< parameter
Wrong or missing >>contact_id<< parameter
Response (when id is wrong):
Shift with the given id does not exists
Contact with the given id does not exists

RESPONSE (XML):
Response:
<xml>
<status>ok</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

141 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong access token):
<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when wrong parameters):

<xml>
<error_text>Wrong or missing >>shift_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>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>

56. Phonebook shift remove contact: JSONRPC method

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

shift_id id of existing shift (or id’s separated with comma)

contact_id id of contact. The contact will be added to the shift

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
{"method":"phonebook.shift_removecontact",

142 | SMSEagle NXS-9750 | User’s Manual

"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"shift_id":"24"
,"contact_id":"1"}}

RESPONSE:
Response: {"result": "OK"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when wrong parameters):
{"result": "Wrong or missing >>shift_id<< parameter"}
{"result": "Wrong or missing >>contact_id<< parameter"}
Response (when id is wrong):
{"result": "Shift with the given id does not exists"}
{"result": "Contact with the given id does not exists"}

RESPONSE (EXTENDED):
Response: {"result":{"status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when wrong parameters):

{"result": {"error_text":"Wrong or missing >>shift_id<<
parameter","status":"error"}}

{"result": {"error_text":"Wrong or missing >>contact_id<<

parameter","status":"error"}}

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

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
multimodem devices

143 | SMSEagle NXS-9750 | User’s Manual

 responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/get_modem_state?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&modem_no=1

RESPONSE:
Response: enabled / disabled
Sample response: enabled
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when modem doesn’t exist): Wrong modem number

RESPONSE (XML):
Response:
<xml>
<modem_status>
enabled / disabled
</modem_status>
<status>
ok
</status>
</xml>

Sample response:
<xml>
<modem_status>
enabled
</modem_status>
<status>
ok
</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

144 | SMSEagle NXS-9750 | User’s Manual

Response (when modem doesn’t exist):
<xml>
<error_text> Wrong modem number</error_text>
<status>error</status>
</xml>

58. Get modem state: JSONRPC method

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

modem_no (optional parameter) modem number to be queried (default = 1). Used only in
multimodem devices

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

BODY:
{"method":"sms.get_modem_state",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”}}

RESPONSE:
{"result": enabled / disabled }
Sample response: {"result":"enabled"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when modem doesn’t exist): {"result": "Wrong modem number"}

RESPONSE (EXTENDED):
Response:
{"result":{"modem_status": enabled / disabled,"status":"ok"}}

Sample response: {"result": {"modem_status":"Wrong modem

number","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

145 | SMSEagle NXS-9750 | User’s Manual

Response (when modem doesn’t exist):
{"result": {"error_text":"Wrong modem number","status":"error"}}

59. Set modem state: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/set_modem_state

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 (optional parameter) modem number for status change (default = 1). Used only in
multimodem devices

status enabled / disabled

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/set_modem_state?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&modem_no=1&status=enabled

RESPONSE:
Response: OK
Response (when wrong logindata): Invalid login or password
Response (when wrong access token): Invalid access token
Response (when modem doesn’t exist): Wrong modem number
Response (when wrong modem state): Wrong modem state

RESPONSE (XML):
Response:
<xml>
<status>
ok
</status>
</xml>

Response (when wrong logindata):

<xml>
<error_text>Invalid login or password</error_text>
<status>error</status>
</xml>

Response (when wrong access token):

146 | SMSEagle NXS-9750 | User’s Manual

<xml>
<error_text>Invalid Access token</error_text>
<status>error</status>
</xml>

Response (when modem doesn’t exist):

<xml>
<error_text> Wrong modem number</error_text>
<status>error</status>
</xml>

Response (when wrong modem state):

<xml>
<error_text>Wrong modem state</error_text>
<status>error</status>
</xml>

60. Set modem state: JSONRPC method

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

modem_no (optional parameter) modem number for status change (default = 1). Used only in
multimodem devices

status enabled / disabled

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

BODY:
{"method":"sms.set_modem_state",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,
"status":"enabled"}}

RESPONSE:
{"result": enabled / disabled }
Sample response: {"result":"enabled"}
Response (when wrong logindata): {"result": "Invalid login or password"}
Response (when wrong access token): {"result": "Invalid access token"}
Response (when modem doesn’t exist): {"result": "Wrong modem number"}

147 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong modem state): {"result": "Wrong modem state"}

RESPONSE (EXTENDED):
Response:
{"result":{"modem_status": enabled / disabled,"status":"ok"}}

Sample response: {"result": {"modem_status":"Wrong modem

number","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}

Response (when wrong access token):

{"result": {"error_text":"Invalid access token","status":"error"}}

Response (when modem doesn’t exist):

{"result": {"error_text":"Wrong modem number","status":"error"}}

Response (when wrong modem state):

{"result": {"error_text":"Wrong modem state","status":"error"}}

61. User ID read: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/userid_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)

pass your password to login to SMSEagle

username username to be queried

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/userid_read?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&username=myuser

RESPONSE:
Response: User ID
Sample response: 24
Response (when username parameter is missing): Missing >>username<< parameter
Response (when user doesn’t exist): Wrong >>username<< parameter

148 | SMSEagle NXS-9750 | User’s Manual

RESPONSE (XML):
Response:
<xml>
<status>
ok
</status>
</xml>

Response (when username parameter is missing):

<xml>
<error_text>Missing >>username<< parameter</error_text>
<status>error</status>
</xml>

Response (when user doesn’t exist):

<xml>
<error_text>Wrong >>username<< parameter</error_text>
<status>error</status>
</xml>

62. User ID read: JSONRPC method

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

username username to be queried

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

BODY:
{"method":"phonebook.userid_read",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"username":"myu
ser"}}

RESPONSE:
{"result": [user ID] }
Sample response: {"result":"24"}
Response (when username parameter is missing): {"result": "Missing >>username<<
parameter"}
Response (when user doesn’t exist): {"result": "Wrong >>username<< parameter"}

149 | SMSEagle NXS-9750 | User’s Manual

RESPONSE (EXTENDED):
Response:
{"result":{"uid": [user ID],"status":"ok"}}

Sample response: {"result": {"uid":"24","status":"ok"}}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}
Response (when wrong access token):
{"result": {"error_text":"Invalid access token","status":"error"}}
Response (when username parameter is missing):
{"result": {"error_text":"Missing >>username<<
parameter","status":"error"}}
Response (when user doesn’t exist):
{"result": {"error_text":"Wrong >>username<< parameter","status":"error"}}

63. Group members read: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/http_api/group_members_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)

pass your password to login to SMSEagle

group_id ID of group to be queried

user_id (optional parameter) show only contacts created by user with given ID

public (optional parameter) 0 = private, 1 = public

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

EXAMPLES:
https://url-of-smseagle/http_api/group_members_read?
access_token=0005gOjCOlMH8F2BPo8mWqcGzycVHRLq&group_id=11

RESPONSE:
Sample response: link
Response (when wrong or missing group_id parameter): Wrong or missing >>group_id<< parameter
Response (when wrong user_id parameter): Wrong >>user_id<< parameter
Response (when wrong public parameter): Wrong >>public<< parameter
Response (when result set is empty): No data to display

RESPONSE (XML):
Response:

150 | SMSEagle NXS-9750 | User’s Manual

<xml>
<contacts>
<contact>
<ID>17</ID>
<Name>mycontact1</Name>
<Number>23456</Number>
<id_user>1</id_user>
<is_public>true</is_public>
</contact>
<contact>
<ID>24</ID>
<Name>mycontact3</Name>
<Number>12345</Number>
<id_user>3</id_user>
<is_public>false</is_public>
</contact>
</contacts>
</xml>

Response (when wrong or missing group_id parameter):

<xml>
<error_text>Wrong or missing >>group_id<< parameter</error_text>
<status>error</status>
</xml>

Response (when wrong user_id parameter):

<xml>
<error_text>Wrong >>user_id<< parameter</error_text>
<status>error</status>
</xml>

Response (when wrong public parameter):

<xml>
<error_text> Wrong >>public<< parameter </error_text>
<status>error</status>
</xml>

64. Group members read: JSONRPC method

HTTP POST METHOD:

https://url-of-smseagle/jsonrpc/sms

Parameter Description

access_token authentication access token (see details in point API Authentication)

151 | SMSEagle NXS-9750 | User’s Manual

 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 (optional parameter) show only contacts created by user with given ID

public (optional parameter) 0 = private, 1 = public

responsetype (optional parameter) text = format response as text (default), xml = format
response as XML object

BODY:
{"method":"phonebook.group_members_read",
"params":{“access_token”:”0005gOjCOlMH8F2BPo8mWqcGzycVHRLq”,"group_id":"11"
}}

RESPONSE:
Sample response:

{
"result": [
{"ID":"1706","Name":"mycontact1","Number":"23456",
"id_user":"1","is_public":"true"},
{"ID":"1693","Name":"mycontact3","Number":"12345",
"id_user":"3","is_public":"false"}
]
}

Response (when wrong or missing group_id parameter): {"result": "Wrong or missing

>>group_id<< parameter"}
Response (when wrong user_id parameter): {"result": "Wrong >>user_id<< parameter"}
Response (when wrong public parameter): {"result": "Wrong >>public<< parameter"}

RESPONSE (EXTENDED):
Sample response:
{
"result": {
"contacts": [
{"ID":"1706","Name":"mycontact1","Number":"23456",
"id_user":"1","is_public":"true"},
{"ID":"1693","Name": "mycontact3","Number":"12345",
"id_user":"3","is_public":"false"}
],
"status": "ok"
}
}

Response (when wrong logindata):

{"result": {"error_text":"Invalid login or password","status":"error"}}
Response (when wrong access token):
{"result": {"error_text":"Invalid access token","status":"error"}}
Response (when wrong or missing group_id parameter):
{"result": {"error_text":"Wrong or missing >>group_id<<
parameter","status":"error"}}

152 | SMSEagle NXS-9750 | User’s Manual

Response (when wrong user_id parameter):
{"result": "Wrong >>user_id<< parameter"}
Response (when wrong public parameter):
{"result": "Wrong >>public<< parameter"}

153 | SMSEagle NXS-9750 | User’s Manual

PLUGINS AND INTEGRATION MANUALS FOR NMS & AUTH SYSTEMS

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: http://www.smseagle.eu/integration-plugins/

154 | SMSEagle NXS-9750 | User’s Manual

EXTRAS

Connecting directly to SMSEagle database

SMSEagle’s database operates on PostgreSQL database engine. You may use a direct access to database for
reading/writing SMS messages directly from/to database via SQL queries.

The database access for external applications is disabled by default. In order to enable it, go to webGUI >
menu Settings and enable to following setting:

Once database access is enabled, it is possible to connect to the database from external application using
the following credentials:

P OSTGRE SQL 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 (

DestinationNumber,
TextDecoded,
CreatorID,
Coding,
Class,
SenderID
) VALUES (
'1234567',
'This is a SQL test message',
'Program',
'Default_No_Compression',
-1,

155 | SMSEagle NXS-9750 | User’s Manual

 'smseagle1'
);

INSERT INTO user_outbox (

id_outbox,
id_user
) SELECT CURRVAL(pg_get_serial_sequence('outbox','ID')), 1;

In the above example the message will belong to user with id_user 1 (default 'admin'). You can find id_user
values for other users in table public."user". Field SenderID contains identification number of SMSEagle
modem. For modem 1 SenderID = smseagle1 and for modem 2 SenderID = smseagle2.

Injecting long SMS using SQL

Inserting multipart messages is a bit more tricky, you need to construct also UDH header and store it
hexadecimally written into UDH field. Unless you have a good reason to do this manually, use API.

For long text message, the UDH starts with 050003 followed by byte as a message reference (you can put
any hex value there, but it should be different for each message, D3 in following example), byte for number
of messages (02 in example, it should be unique for each message you send to same phone number) and
byte for number of current message (01 for first message, 02 for second, etc.).

For example long text message of two parts could look like following:

INSERT INTO outbox (

"DestinationNumber",
"CreatorID",
"MultiPart",
"UDH",
"TextDecoded",
"Coding",
"Class",
"SenderID"
) VALUES (
'1234567',
'Program',
'true',
'050003D30201',
'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad
minim veniam, qui',
'Default_No_Compression',
-1,
'smseagle1'
)

INSERT INTO outbox_multipart (

156 | SMSEagle NXS-9750 | User’s Manual

 "ID",
"SequencePosition",
"UDH",
"TextDecoded",
"Coding",
"Class"
) SELECT
CURRVAL(pg_get_serial_sequence('outbox','ID')),
2,
'050003D30202',
's nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat.',
'Default_No_Compression',
-1;

INSERT INTO user_outbox (

id_outbox,
id_user
) SELECT
CURRVAL(pg_get_serial_sequence('outbox','ID')),
1;

Note: Adding UDH means that you have less space for text, in above example you can use only 153 characters in
single message.

157 | SMSEagle NXS-9750 | User’s Manual

Database cleaning scripts

We have added some useful scripts which may be used to delete SMS messages from database through
Linux CLI.
Scripts are located at following directory:
/mnt/nand-user/scripts/

• db_delete – script for deleting SMS from folders Inbox, SentItems older than provided date.
Usage:
./db_delete YYYYMMDDhhmm

• db_delete_7days – script for deleting SMS from folders Inbox, Sentitems older than 7 days.
Usage:
./db_delete_7days

• db_delete_allfolders – script for cleaning PostgreSQL database folders (Inbox, SentItems,

Outbox). Specially designed to run periodically through cron. Usage:
./db_delete_allfolders

• db_delete_select - script for deleting SMS from chosen databse folder (Inbox, Outbox,
SentItems, Trash). Usage:
./db_delete_select {inbox|outbox|sentitems|trash}

Adding script to system cron daemon

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 1st day of month.

158 | SMSEagle NXS-9750 | User’s Manual

SNMP agent

“Simple Network Management Protocol (SNMP) is an Internet-standard protocol for managing devices on IP
networks. 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.

Available SNMP metrics that describe a state of a SMSEagle device are:

Metric name Description OID

GSM_Signal Returns GSM/3G signal strength in .1.3.6.1.4.1.8072.1.3.2.3.1.2.11.71

percent. Value range: 0-100. If modem is .83.77.95.83.105.103.110.97.108.
disconnected from GSM/3G network 49
GSM_Signal returns 0.

GSM_NetName1 Returns Network Name used on current .1.3.6.1.4.1.8072.1.3.2.3.1.2.12.71

SIMcard at slot #1 .83.77.95.78.101.116.78.97.109.1
01.49

GSM_NetName2 Returns Network Name used on current .1.3.6.1.4.1.8072.1.3.2.3.1.2.12.71

SIMcard at slot #2 .83.77.95.78.101.116.78.97.109.1
01.50

FolderOutbox_Total Returns number of SMS messages in .1.3.6.1.4.1.8072.1.3.2.3.1.2.18.70

Outbox folder (outgoing queue length) .111.108.100.101.114.79.117.11
6.98.111.120.95.84.111.116.97.1
08

FolderInbox_Total Returns number of SMS messages in Inbox .1.3.6.1.4.1.8072.1.3.2.3.1.2.17.70

folder .111.108.100.101.114.73.110.98.
111.120.95.84.111.116.97.108

FolderSent_Last24H Returns number of SMS messages sent .1.3.6.1.4.1.8072.1.3.2.3.1.2.18.70

from the device within last 24 hours .111.108.100.101.114.83.101.11
0.116.95.76.97.115.116.50.52.72

FolderSent_Last1M Returns number of SMS messages sent .1.3.6.1.4.1.8072.1.3.2.3.1.2.17.70

from the device within last month .111.108.100.101.114.83.101.11
0.116.95.76.97.115.116.49.77

FolderSent_Last24HS Returns number of SMS messages sent .1.3.6.1.4.1.8072.1.3.2.3.1.2.25.70

endErr with error within last 24h. Error occurs .111.108.100.101.114.83.101.11
when 3G modem cannot send SMS 0.116.95.76.97.115.116.50.52.72.
message or message is rejected by GSM 83.101.110.100.69.114.114

159 | SMSEagle NXS-9750 | User’s Manual

 /3G carrier (mostly happens when a credit
on pre-paid SIM card is over)

Temp Returns last value of Temperature (in °C) .1.3.6.1.4.1.8072.1.3.2.4.1.2.4.84.

from internal DHT22 sensor. Requires 101.109.112.1
sensor to be enabled.

Humidity Returns last value of Humidity (in %) from .1.3.6.1.4.1.8072.1.3.2.3.1.2.8.72.

internal DHT22 sensor. Requires sensor to 117.109.105.100.105.116.121
be enabled.

RESULT VALUES

• Using OID

Result values for each custom metric are available and can be fetched from OID given in table above.

• Using textual name

Alternatively result values for each custom metric can be fetched using textual names from OID tree
under: NET-SNMP-EXTEND-MIB::nsExtendOutputFull."[METRIC NAME]"

For example:
Result value for parameter GSM_Signal:
NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_Signal"

If your chosen SNMP tool cannot access NET-SNMP-EXTEND-MIB objects, you can download MIB definitions
from: http://www.smseagle.eu/download/NET-SNMP-EXTEND-MIB.txt

READING RESULT VALUES

In order to test-read the parameter values from SNMP agent you can use any tools available for SNMP
protocol (for example: NET-SNMP library for Linux or iReasoning MiB-Browser for Windows).

EXAMPLE OF READING GSM_SIGNAL VALUE USING NET-SNMP LIBRARY

a) Command for reading the result value:

snmpget -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 Signal strength value is 54%

160 | SMSEagle NXS-9750 | User’s Manual

EXAMPLE OF READING GSM_NETNAME1 VALUE USING NET-SNMP LIBRARY
a) Command for reading the result value:

snmpget -v 2c -c public localhost

.1.3.6.1.4.1.8072.1.3.2.3.1.2.12.71.83.77.95.78.101.116.78.97.109.101.49

Result:

NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_NetName1" = STRING: PLAY

Comment: Currently used network at SIM card #1 is PLAY

EXAMPLE OF READING FOLDEROUTBOX_TOTAL VALUE USING NET-SNMP LIBRARY (AND TEXTUAL NAME
OF METRIC)
a) Command for reading the result value:

snmpget -v 2c -c public ip-of-smseagle 'NET-SNMP-EXTEND-

MIB::nsExtendOutputFull."FolderOutbox_Total"'

Result:

NET-SNMP-EXTEND-MIB::nsExtendOutputFull."FolderOutbox_Total" = STRING: 0

Comment: Number of SMS messages waiting in outbox queue is 0

EXAMPLE OF READING SYSTEMUPTIME FROM LINUX HOST USING NET-SNMP LIBRARY

a) Command for reading the result value:

snmpget -v 2c -c public ip-of-smseagle system.sysUpTime.0

Result:

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" = STRING: 54
NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_NetName1" = STRING: PLAY
NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_NetName2" = STRING: PLAY
NET-SNMP-EXTEND-MIB::nsExtendOutputFull."FolderInbox_Total" = STRING: 15
NET-SNMP-EXTEND-MIB::nsExtendOutputFull."FolderSent_Last1M" = STRING: 19
NET-SNMP-EXTEND-MIB::nsExtendOutputFull."FolderOutbox_Total" = STRING: 0

161 | SMSEagle NXS-9750 | User’s Manual

NET-SNMP-EXTEND-MIB::nsExtendOutputFull."FolderSent_Last24H" = STRING: 0
NET-SNMP-EXTEND-MIB::nsExtendOutputFull." FolderSent_Last24HSendErr" = STRING: 0

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 obsolete. To ease switch to SNMP v3 access control we’ve prepared special shell script located at
/mnt/nand-user/smseagle directory.

1. Log in via SSH using root account

2. Navigate to:
cd /mnt/nand-user/smseagle/
3. Configuration script:
./snmpv3
4. Script can run with following parameters:
i. add
ii. del
iii. enablev2
iv. disablev2
5. To add v3 USER please run:
./snmpv3 add USERNAME PASSWORD ENCRYPTIONPASSWORD

162 | SMSEagle NXS-9750 | User’s Manual

6. To delete USER please run:
./snmpv3 del

7. To disable v2 access policy run:

./snmpv3 disablev2

8. To enable v2 access policy run:

./snmpv3 enablev2

163 | SMSEagle NXS-9750 | User’s Manual

Failover (HA-cluster) feature

"High-availability clusters (also known as HA clusters or fail over clusters) are groups of computers (...) that can be
reliably utilized with a minimum of down-time. They operate by using high availability software to harness
redundant computers in groups or clusters that provide continued service when system components fail. Without
clustering, if a server running a particular application crashes, the application will be unavailable until the crashed
server is fixed. HA clustering remedies this situation by detecting hardware/software faults, and immediately
restarting the application on another system or whole node without requiring administrative intervention, a process
known as failover." (source: Wikipedia)

SMSEagle NXS-family devices has it’s 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 at least 2 devices ('aka' nodes). The failover feature monitors devices working in the cluster, and
detects faults with the following services:

1. Apache2 WWW server

2. PostgreSQL database
3. SNMP agent
4. Modem software (Gammu-SMSD daemon)
5. Accessibility (response to ping) of whole node.

Every node in a cluster can have one of three states:

• Master: main healthy node in a cluster, by default accessible through Virtual IP

• Backup: second healthy node in a cluster, ready and waiting for replacing Master when needed
• Fault: node with detected service fault

164 | SMSEagle NXS-9750 | User’s Manual

In the cluster you have one MASTER device and one BACKUP device. HA-cluster is accessed via Virtual IP
address. 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. If nodes are
on the same network (same subnet & IP range) there is no need for any network configuration. If two nodes
are behind firewalls, make sure firewall is configured to accept multicast and VRRP protocol (IP Protocol
#112).

HOW TO CONFIGURE FAILOVER (HA-CLUSTER):

Failover cluster can be easily configured using web-gui. Configuration can be done in menu “Settings” > tab
“Failover”. For each device in failover cluster:

• enter virtual IP address in the field “Virtual IP Address”

• enter Master and Backup IP addresses (these should be physical addresses of your devices)
• set “Enable Failover cluster” to “Yes”
• optionally you can enable database replication between nodes (feature available only in devices
with hardware Rev.2 and higher)

Save configuration. Reboot each device after saving. The configuration should be exactly the same on both
devices in HA-cluster.

165 | SMSEagle NXS-9750 | User’s Manual

Screenshot from “General settings-Failover”

Database replication between nodes allows to automatically replicate database content from MASTER to
BACKUP (one direction only). In the current software version, the following content is replicated: Folders
(with messages), Phonebook contacts, Users. Please note that this feature is only available in devices with
hardware Rev.2 and higher.

After correct configuration of the HA-cluster you should access the cluster via its Virtual IP address.

SNMP-monitoring of HA-cluster
Failover feature uses KEEPALIVED-MIB for SNMP monitoring.

EXAMPLE OF READING DEVICE CLUSTER STATE 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

166 | SMSEagle NXS-9750 | User’s Manual

Forwarding logs to external server

Our devices runs rsyslog for log managing. Here we describe how to configure additional rules for rsyslog
daemon: rsyslogd. This is only a brief excerpt from rsyslog manual website. Full information is available at:
http://www.rsyslog.com/

Rsyslogd configuration is managed using a configuration file located at /etc/rsyslog.conf

• At the bottom of the configuration file add:

*.* action(type="omfwd" target="SERVER_IP" port="PORT" protocol="PROTOCOL"

action.resumeRetryCount="10"
queue.type="linkedList" queue.size="10000")

where: SERVER_IP – IP (or FQDN) address of receiving server

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:

http://www.rsyslog.com/doc/v8-stable/tutorials/tls_cert_summary.html

167 | SMSEagle NXS-9750 | User’s Manual

Automatic software updates checks

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. Web-GUI offers you a possibility to automatically check
for new software updates. This can be done in two ways:

MANUAL CHECK
In order to manually check for available software updates, go to menu Settings > tab Maintenance. Click on
the button “Check manually now”. At the top pops up a balloon in red with information if it is up-to-date.

AUTOMATIC CHECK
In order to start automatic checks for software updates go to menu Settings > tab Maintenance, and check
the option “Automatically check for software updates”. This will enable periodic checks (once a month) for
available software updates. If a new update is available, a message “Update Available” will appear in menu
Settings> Sysinfo – next to the current software version number.
If you select “Notify Admin about new software version by SMS”, the device will additionally send SMS to
the default admin account (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.

168 | SMSEagle NXS-9750 | User’s Manual

 III TROUBLESHOOTING

169 | SMSEagle NXS-9750 | User’s Manual

TROUBLESHOOTING

To make sure that the device is working properly, follow the three steps:

1. Verification of LEDs
2. Checking the device configuration (IP Settings)
3. Check the device logs (description below)

Verification of LEDs
Normal operation of the device is signaled by LEDs as follows:

LED Correct operation

Power (PWR) Continuously lit

User Blinks during flashdisk read/write

Ready (RDY) Blinking

SIM1 Slow flashing in stand-by mode, Quick flashing when modem 1 in use

SIM2 Slow flashing in stand-by mode, Quick flashing when modem 2 in use

Checking the device information

The device information (device type, software version, modem IMEI, IMSI, network signal strength, network
name) can be found under menu “Settings” > “Sysinfo”.

Device logs
Under menu “Settings” > “Sysinfo” you can find latest lines of device logs: modem log, database log and
system log. 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”.

170 | SMSEagle NXS-9750 | User’s Manual

When the device is not reachable
1. Check if the device is correctly connected to the network. Check LED status of RJ45 socket.

2. In the case when the device does not respond due to a malfunction or incorrect user settings please
reboot the device by disconnecting and connecting power source (or pressing Reset switch).

3. If you still cannot connect with the device, it is possible to restore to factory IP settings by using the
SW button.

Restoring factory defaults

This action restores the following settings to default values: IP settings, time zone settings, database
content, Linux OS users/passwords

In order to restore factory defaults proceed with the following steps:

LED signaling USER actions System reaction

1. When the device is

ready to operate

2. Press and hold SW 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.

171 | SMSEagle NXS-9750 | User’s Manual

 4. Wait until system 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.

172 | SMSEagle NXS-9750 | User’s Manual

 IV SERVICE & REPAIR

173 | SMSEagle NXS-9750 | User’s Manual

SERVICE & REPAIR

Warranty

Your SMSEagle comes with a standard 1 year of technical support and hardware repair warranty coverage.
The standard warranty can be extended during device purchase to 3-years coverage (check your purchase
conditions). For a detailed information on warranty terms and conditions check warranty card that comes
with your device or follow the link: www.smseagle.eu/docs/general_warranty_terms_and_conditions.pdf

Service

Before contacting with support team, be sure that you have read Troubleshooting section of this manual.
SMSEagle Support Team is available by email or telephone.

Support Email: [email protected]

Support telephone: + 48 61 6713 411

The support service is provided by:

Proximus Software
ul. Piątkowska 163,
60-650 Poznan, Poland

WHEN CONTACTING SUPPORT TEAM, BE PREPARED TO PROVIDE THE FOLLOWING INFORMATION:

System Logs

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

174 | SMSEagle NXS-9750 | User’s Manual

 V
TECH SPECS
& SAFETY
INFORMATION

175 | SMSEagle NXS-9750 | User’s Manual

TECH SPECS & SAFETY INFORMATION

Technical Specification

HARDWARE SPECIFICATION
• Processor type:

o hardware Rev.3, Rev. 2: Broadcom BCM2837 1.2 GHz quad-core ARM Cortex-A53 (64-bit)

o hardware Rev.1: Broadcom BCM2835 0.7GHz ARM11

• Operational memory (RAM):

o hardware Rev.3, Rev.2: 1GB LPDDR2 @ 900 MHz

o hardware Rev.1: 512 MB SDRAM @ 400 MHz

• 4GB eMMC storage

• Network interface: Ethernet (1xRJ45)

o hardware Rev.3: Gigabit Ethernet 10/100/1000 TX

o hardware Rev.2, Rev.1: Fast Ethernet 10/100 TX

• HDMI port for debugging purposes

• Other external ports

o hardware Rev.3: 2xUSB 2.0, 4x DI, 4x DO, 1x 1Wire

o hardware Rev.2, Rev.1: 1xUSB 2.0, 2x DI, 2x DO, 2x RS232 serial ports

• Digital Input/Output port types:

o hardware Rev.3: DI type “pull-up resistor”. DO type “open collector”

o hardware Rev.2, Rev.1: DI/DO voltage input/output

• RTC Clock: RTC 240B SRAM, Watchdog timer

• Internal humidity & temperature sensor: Accuracy ± 0,5 °C, ±2 %RH

• Power consumption: max 27W

• Noise level: Fan-less

• Dimensions: (width x depth x height) 35 x 120 x 101 mm

• Weight: 350g

• Casing: ABS, DIN rail installation

• Operating parameters:

o Operating temperature: 0 ~ 40°C

o Humidity: 8 ~ 90% RH (no condensation)

176 | SMSEagle NXS-9750 | User’s Manual

 • 2x Internal modem

Device type NXS-9750-3G:

o Waveband: GSM, UMTS

o GSM/GPRS quad-band 850/900/1800/1900 MHz

o UMTS 800/850/900/AWS 1700/1900/2100 MHz

o Output power (Rated):

 E-GSM 900: Class 4, DCS 1800: Class1

 EDGE 900: Class E2, EDGE 1800: Class E2

 FDD I: Class 3, FDD VIII: Class 3

Device type NXS-9750-4G:

o Waveband: UMTS, LTE

o LTE Bands:

LTE FDD: 1-5, 7, 8, 12, 13, 17, 20, 25, 26, 28, 29, 30 (Rx only), 66

LTE TDD: 38, 40, 41

o 3G Bands: 1, 2, 4, 5, 8

o Output power:

 Class 3 (0.2 W, 23 dBm) @ LTE

 Class 3 (0.25 W, 23 dBm) @ 3G

 Class 4 (2W) @ E-GSM 900

 Class 1 (1W) @ DCS 1800

• SIM card standard: mini

• Antenna connector: 2x SMA

• Country of origin: European Union (Poland)

POWER SUPPLY
AC line input

Voltage ranges: 100–240V alternating current (AC)

Frequency: 50–60Hz single phase

DC plug type: 5.5/2.5

ANTENNA
• Device type NXS-9750-3G:

177 | SMSEagle NXS-9750 | User’s Manual

 o Omnidirectional 3dBi antenna with magnetic foot

o Waveband: GSM,UMTS

o Cable length 3m

• Device type NXS-9750-4G:

o Omnidirectional 2dBi antenna with magnetic foot

o Waveband: GSM,UMTS, LTE

o Cable length 3m

SENDING/RECEIVING THROUGHPUT
• Incoming transmission rate: up to 60 SMS/min

• Outgoing transmission rate: up to 60 SMS/min

SOFTWARE PLATFORM
• Operating system: Linux

o hardware Rev. 3: kernel 4.14

o hardware Rev. 2: kernel 4.4

o hardware Rev. 1: kernel 4.1

• built-in Apache2 web server

• built-in PostgreSQL database server

• built-in Postfix email server

• built-in SNMP agent

• built-in NTP-client

• built-in Failover (HA-cluster) service

• watchdog mechanism for 3G/4G modems

• failover mechanism for built-in 3G/4G modems

• modern responsive web interface

178 | SMSEagle NXS-9750 | User’s Manual

Important Safety Information

This chapter provides important information about safety procedures. For your safety and that of your

equipment, follow these rules for handling your device.

WARNING: Incorrect storage or use of your device may void the manufacturer’s warranty. Failure to

follow these safety instructions could result in fire, electric shock, or other injury or damage.

Always take the following precautions.

Disconnect the power plug from AC power source or if any of the following conditions exist:

• the power cord or plug becomes frayed or otherwise damaged

• you spill something into the case

• the device is exposed to rain or any other excess moisture

• the device has been dropped or the case has been otherwise damaged

Be sure about that the use of this product is allowed in your country and in the environment required. As with

any other telecommunication equipment, the use of this product may be dangerous and has to be avoided in

the following areas: where it can interfere with other electronic devices in environments such as hospitals,

airports, aircrafts, etc.; where there is risk of explosion such as gasoline stations, oil refineries, etc.

It is responsibility of the user to enforce the country regulation and the specific environment regulation.

Do not disassemble the product; any mark of tampering will compromise the warranty validity.

Every device has to be equipped with a proper antenna with specific characteristics. The antenna has to be

installed with care in order to avoid any interference with other electronic devices and has to be installed with

the guarantee of a minimum 20 cm distance from the body. In case of this requirement cannot be satisfied,

the system integrator has to assess the final product against the 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.

179 | SMSEagle NXS-9750 | User’s Manual

REGULATORY STATEMENTS

EU declaration of conformity

Hereby, PROXIMUS Radoslaw Janowski, owner of SMSEagle brand, declares that the radio equipment type
SMSEagle NXS-9750-3G, NXS-9750-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

FCC compliance statement

This device complies with part 15 of the FCC rules. Operation is subject to the following two conditions:

(1) This device may not cause harmful interference, and

(2) this device must accept any interference received, including interference that may cause undesired
operation.

Note:
This equipment has been tested and found to comply with the limits for a Class B device, pursuant to part 15
of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in
a business/commercial non-residential environment. However, there is no guarantee that interference will
not occur in a particular installation. If this equipment does cause harmful interference to radio or television
reception, which can be determined by turning the equipment off and on, the user is encouraged to try to
correct the interference by one or more of the following measures:

• Reorient or relocate the receiving antenna.

• Increase the separation between the equipment and receiver.
• Connect the equipment to an outlet on a circuit different from that to which the receiver is
connected.
• Consult the dealer or an experienced radio/TV technician for help.

Important:
This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in
accordance with the manufacturer’s instruction manual, may cause harmful interference with radio
communications. Operation of this equipment in a residential area is likely to cause harmful interference, in
which case you will be required to correct the interference at your own expense. The FCC regulations provide
that changes or modifications not expressly approved by SMSEagle™ could void your authority to operate this
equipment. This product has demonstrated EMC compliance under conditions that included the use of
compliant peripheral devices (antennas) and shielded cables between system components. It is important
that you use compliant peripheral devices and shielded cables between system components to reduce the
possibility of causing interference to radios, televisions, and other electronic devices.

180 | SMSEagle NXS-9750 | User’s Manual

Canadian regulatory statement

This device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the
following two conditions:

(1) this device may not cause interference, and

(2) this device must accept any interference, including interference that may cause undesired operation of
the device.

This Class B digital apparatus meets the requirements of the Canadian Interference-Causing Equipment
Regulations.

CAN ICES-3 (B)/NMB-3(B)

Disposal and recycling information

Your SMSEagle device contains lithium-ion 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. When this product reaches its end of life, take it to a collection point
designated by local authorities. The separate collection and recycling of your product at the time of disposal
will help conserve natural resources and ensure that it is recycled in a manner that protects human health
and the environment.

For disposal in countries outside of the European Union

This symbol is only valid in the European Union (EU). If you wish to discard this product please contact your
local authorities or dealer and ask for the correct method of disposal.

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
2011/65/EU on the restriction of the use of certain hazardous substances in electrical and electronic
equipment (“RoHS recast” or “RoHS 2”).

181 | SMSEagle NXS-9750 | User’s Manual

 Ul. Piątkowska 163, 60-650
Poznań, Poland l Europe
T +48 61 6713 413
E [email protected]
www.smseagle.eu

182 | SMSEagle NXS-9750 | User’s Manual