SMSEagle NXS-9700-3G User Manual

SMSEagle NXS-9700-3G User Manual

Hide thumbs Also See for NXS-9700-3G:
Table of Contents

Advertisement

Quick Links

SMSEAGLE
NXS-9700-3G
NXS-9700-4G
Rev. 1, Rev. 2, Rev. 3, Rev.4
User's Manual

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the NXS-9700-3G and is the answer not in the manual?

Questions and answers

Summary of Contents for SMSEagle NXS-9700-3G

  • Page 1 SMSEAGLE NXS-9700-3G NXS-9700-4G Rev. 1, Rev. 2, Rev. 3, Rev.4 User’s Manual...
  • Page 2 Congratulations on purchasing SMSEAGLE The materials used in this publication are copyright and are not to be duplicated, copied, or used without the prior consent of the copyright holder. Technical specifications and information in this document are subject to change without prior notice being given.
  • Page 3: Table Of Contents

    CONTENTS SMSEagle Software Licensing Information ...................... 10 What’s In The Box ..............................16 Prepare for First Start ............................. 17 Get to know with Connectors, Ports and LEDs ....................22 Basic Operations............................... 23 SMSEagle basic features ............................24 Compose SMS ............................... 24 Importing SMS from CSV and using placeholders ..................
  • Page 4 Backup/Restore ............................... 46 SNMP .................................. 47 Updates ................................47 Failover (HA-cluster) feature ..........................50 SMSEagle plugins ..............................53 Network Monitoring plugin ..........................53 Email to SMS plugin ............................57 Email to SMS Poller ............................. 60 SMS to Email plugin ............................63 SMS Forward ................................
  • Page 5 9. Send binary SMS: HTTP GET method ..................... 100 10. Send binary SMS: JSONRPC method ....................101 11. Read SMS: HTTP GET method ....................... 102 12. Read SMS/MMS: JSONRPC method..................... 110 13. Delete SMS: HTTP GET method ......................124 14. Delete SMS: JSONRPC method ......................125 15.
  • Page 6 39. Phonebook contact update: HTTP GET method ................157 40. Phonebook contact update: JSONRPC method ................. 158 41. Phonebook contact delete: HTTP GET method ................. 160 42. Phonebook contact delete: JSONRPC method .................. 161 43. Call with termination: HTTP GET method ................... 162 44.
  • Page 7 Plugins and integration manuals for NMS & Auth systems ..............199 Extras ..................................200 Delivery Reports ............................... 200 Connecting directly to SMSEagle SQL database ..................200 Injecting short SMS using SQL ........................201 Injecting long SMS using SQL ........................202 Database cleaning scripts ..........................
  • Page 8 FCC Compliance Statement ........................... 225 Canadian Regulatory Statement ......................... 226 Avis de conformité à la réglementation d’Industrie Canada ............... 226 UK Declaration of Conformity ........................226 RF Exposure Limits ............................226 Disposal and Recycling Information ......................227 Information gemäß § 4 Absatz 4 Elektrogesetz (DE) ................227 Restriction of Hazardous Substances Directive (RoHS) ................
  • Page 9 GET READY TO START | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 10: Smseagle Software Licensing Information

    YOU AGREE TO BE LEGALLY BOUND BY THE HEREIN-CONTAINED TERMS OF THIS LICENSE AGREEMENT. IF YOU DO NOT AGREE TO BE BOUND BY THE TERMS OF THIS EULA, DO NOT USE THE SMSEAGLE DEVICE AND YOU MAY CHOOSE TO PROMPTLY RETURN THE DEVICE FOR A REFUND OF ITS PURCHASE PRICE BY CONTACTING PROXIMUS AT THE ADDRESS ABOVE.
  • Page 11 1.04 "Update" means maintenance of, or a fix to, a version of SMSEagle Software, including, but not limited to a hot fix, patch, or enhancement, none of which function as a standalone service or other software package and which do not have an additional cost for an existing Licensee.
  • Page 12 Intellectual Property laws and treaties. 3.02 RESTRICTIONS ON USE. As a Licensee, You may not: (a) Make use of the SMSEagle Software on more than one device at a time, without prior purchase of additional devices; (b) Share or otherwise make available the SMSEagle Software, in any manner whatsoever, to any third party (c) Modify, adapt, create derivative works from or translate any part of the SMSEagle Software other than what may be used within Your SMSEagle device in accordance with this License;...
  • Page 13 FOR A PARTICULAR USE, AND NONINFRINGEMENT. LIMITATION OF LIABILITY AND REMEDIES IN SPITE OF ANY DAMAGES ARISING FROM OR RELATED TO THE SMSEAGLE DEVICE AND SMSEAGLE SOFTWARE OR ITS OPERATION THAT YOU MAY INCUR FOR ANY REASON, WHICH MAY INCLUDE, BUT ARE NOT LIMITED TO, ANY AND ALL DAMAGES IN CONTRACT, TORT OR...
  • Page 14 DATA COLLECTION STATEMENT. PROXIMUS does NOT collect ANY data you are working with when You use SMSEagle device. We could not see or collect any data saved on SMSEagle device, because we do not have any access to Your device.
  • Page 15 CONTACT INFORMATION If you have questions regarding this EULA, please contact PROXIMUS at: Proximus Sp. z o.o. Ul. Piątkowska 163 60-650 Poznań Poland | Europe tel. + 48 61 6713 413 https:/ /www.smseagle.eu hello@smseagle.eu support@smseagle.eu | SMSEagle NXS-9700 | User’s Manual...
  • Page 16: What's In The Box

    WHAT’S IN THE BOX Your SMSEagle box contains: • SMSEagle hardware SMS gateway • External omnidirectional antenna (with magnetic foot) AC/DC power supply (input voltage: 100-240V) • Warranty card • | SMSEagle NXS-9700 | User’s Manual...
  • Page 17: Prepare For First Start

    PREPARE FOR FIRST START Your SMSEagle is designed so that you can set it up quickly and start using it right away. Follow the steps below to get started. Install 3G/4G antenna STEP 1: ANTENNA INSTALLATION GUIDELINES Install the antenna in a location with access to a cellular network radio signal.
  • Page 18 SMSEAGLE DEFAULT NETWORK CONFIGURATION: DHCP CLIENT IS ON IP ADDRESS WILL BE OBTAINED AUTOMATICALLY FROM YOUR DHCP SERVER CONNECT SMSEAGLE TO YOUR LAN AND OBTAIN IP ADDRESS AUTOMATICALLY connect the device to your LAN using Ethernet cable • SMSEagle will obtain IP address automatically from your DHCP •...
  • Page 19 PREPARE FOR FIRST START LOG IN TO SMSEAGLE Open an internet browser on your PC and go to the IP address assigned to your gateway SMSEAGLE DEFAULT USER: Username: admin Password: password Login to application with above username and password.
  • Page 20 SSL certificate or a free Let’s Encrypt SSL certificate. Using HTTPS only By default, SMSEagle webGUI can be accessed via HTTP or HTTPS. For improved security we recommend using HTTPS. If you would like to redirect HTTP > HTTPS, follow instructions in the chapter SSL Certificate and HTTPS Redirection.
  • Page 21 USING OF SMSEAGLE | SMSEagle NXS-9700 | User’s Manual...
  • Page 22: Get To Know With Connectors, Ports And Leds

    LED for user application purpose SIM1,2 LEDs Modem 1,2 (optional) LED indicator for modem status Ready LED LED indication device status Reset Switch for rebooting the device User Switch Switch for restoring to factory settings | SMSEagle NXS-9700 | User’s Manual...
  • Page 23: 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.
  • Page 24: Smseagle Basic Features

    SMSEAGLE BASIC FEATURES Sending & Receiving SMS (managing messages with Inbox, Outbox, Sent Items). Different message • types (normal SMS, flash, WAP push, USSD codes) Sending & Receiving MMS (webGUI & API) • Smartphone-like conversation mode (messages are nicely grouped by phone number). You can •...
  • Page 25: Importing Sms From Csv And Using Placeholders

    Importing SMS from CSV and using placeholders SMSEagle software allows you to import SMS text from CSV file and (optionally) use special placeholders in a message body. Placeholders are special fields which are replaced with unique values for each message.
  • Page 26: Folders

    • Trash • The view of conversations can be either of type “Balloons” (smartphone like conversation) or “Table” (tabular view). The view type can be changed in menu Settings > Application. Balloons view type: | SMSEagle NXS-9700 | User’s Manual...
  • Page 27: Mms

    Table view type: To view an MMS attachment, you need to click “show MMS attachment” in the inbox message. | SMSEagle NXS-9700 | User’s Manual...
  • Page 28: Purge Folders (Automatic Message Cleanup)

    Purging interval (daily, weekly, monthly or annually) • Set the time • Select the folder (Inbox, Outbox or Sent Items) • Set time span of messages • Select to delete modem log files • | SMSEagle NXS-9700 | User’s Manual...
  • Page 29: Phonebook

    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.
  • Page 30: Phonebook Groups

    In Phonebook Group Management view users can: Add/edit/delete groups • Set groups to public or private visbility • Set group escalation • View group content (contacts beloning to the group) • Send message to a group • | SMSEagle NXS-9700 | User’s Manual...
  • Page 31: Phonebook Escalation Groups

    STOP word is received. Screenshot from Manage Group view You can change the escalation order by dragging contacts up or down. Screenshot from Manage Groups with set escalation | SMSEagle NXS-9700 | User’s Manual...
  • Page 32: Phonebook Working Shifts

    There are two access levels for a user: User role “Administrator”: • Allows full access & control of the device including settings and User management. User role “User”: • Limits access only allowing to Compose, Folders, Phonebook and Reporting module. | SMSEagle NXS-9700 | User’s Manual...
  • Page 33: Multi-User Capabilities

    Screenshot of Edit/Add User window Multi-User Capabilities As described in the “Users” chapter, SMSEagle software allows to create multiple users with different access leves (Administrator or User). Those users may access the device simultaneously via webGUI or API. The following set of features is available in multi-user work scenario: Multiple users may acess the device simultaneously via webGUI or API •...
  • Page 34: Statistics View

    Statistics view The reporting module allows also to view daily statistics of sent/received messages. The statistics view displays number of messages per day and sender/receiver number. Screenshot of Statistics view in Reporting module Multi-Factor Authentication | SMSEagle NXS-9700 | User’s Manual...
  • Page 35 USER LOGIN WITH MFA Once MFA is activated, the user must provide two factor authentication (user and password + one-time SMS token) every time he logs in to Web-GUI. One-time SMS token is valid for 10 minutes. | SMSEagle NXS-9700 | User’s Manual...
  • Page 36 Screenshot from User Settings > MFA. Recovery code is revealed after entering password ENABLE MFA BY ADMINISTRATOR MFA can also be enabled by an administrator role for selected users. This is done in the menu Users > Edit User. | SMSEagle NXS-9700 | User’s Manual...
  • Page 37: Settings

    Screenshot from Edit/Add User Settings Settings menu is divided into several tabs for easier maintenance. Application Settings Application settings can be changed under the Settings Tab > Application. | SMSEagle NXS-9700 | User’s Manual...
  • Page 38: Ip Settings

    You can enable/disable Password complexity verification. When enabled user password must be at • least 8 characters long and include at least one lowercase letter, uppercase letter, number and special character IP Settings IP settings can be changed under the Settings tab > IP Settings. | SMSEagle NXS-9700 | User’s Manual...
  • Page 39: Failover

    You can input Hostname • You can choose to Use proxy • Failover Failover configuration has been described in chapter “Failover (HA-cluster) feature”. Date/Time Date/Time settings can be changed under the Settings Tab > Date/Time | SMSEagle NXS-9700 | User’s Manual...
  • Page 40: Maintenance

    NTP server on SMSEagled device (date & time will be obtained from 3G/4G network) You can set NTP timeserver address • Maintenance Maintenance settings can be accessed under the Settings tab > Maintenance | SMSEagle NXS-9700 | User’s Manual...
  • Page 41: Email Alerts

    Email Alerts feature allows to send email alert message to a selected email address once SMS sending errors occurs. When a defined error counter threshold is reached, alert email is triggered. The feature can be accessed under Settings tab > Email Alerts | SMSEagle NXS-9700 | User’s Manual...
  • Page 42 You can save debug information in system log (enable this only for troubleshooting) • Notice: To prevent false alarms we recommend to set parameter “Send alert when error counter exceeds” to value > 2. | SMSEagle NXS-9700 | User’s Manual...
  • Page 43: Call Forward

    Call forward settings can be accessed under the Settings tab > Call forward. You can choose to forward all incoming calls to a chosen number • MMS Settings can be accessed under the Settings tab > MMS. | SMSEagle NXS-9700 | User’s Manual...
  • Page 44: Data Connection

    Here you can control a mobile data connection on your device. It can be used, for example, to utilize SMSEagle as a backup Internet source. Data connection is NOT REQUIRED for normal operation of SMSEagle device. Leave it disabled (OFF) if you don't want to use it.
  • Page 45: Ssl Certificate And Https Redirection

    HTTP to HTTPS traffic. SSL Certificate BY default, SMSEagle device is equipped with a self-signed SSL certificate. If you want to install your own certificate on the device, please obtain a valid certificate file issued by a Certificate Authority. To upload the certificate, please provide the certificate file and private key in PEM format.
  • Page 46: Backup/Restore

    This file should be uploaded together with SSL certificate. Backup/Restore Backup and restore settings can be accessed under the Settings tab > Backup/Restore You can create a backup of your device settings • You can enable automatic backup to SFTP/FTP(S) • | SMSEagle NXS-9700 | User’s Manual...
  • Page 47: Snmp

    Update settings can be accessed under the menu Settings > Updates tab. SMSEagle software is under process of continual improvement. We listen to our customers, and new releases are based on our customer’s inputs/requests. Software updates are released frequently, and offer access to new features and fixes to reported issues.
  • Page 48 A month before expiration of a support package your device will notify you about the upcoming expiration date and conveniently provide a link to our online store and sales partners where you can renew your package. Screenshot from “General Settings-Updates” | SMSEagle NXS-9700 | User’s Manual...
  • Page 49 Notice: Your SMSEagle device must have a HTTPS connectivity with the address updates.smseagle.eu in order for this feature to work. | SMSEagle NXS-9700 | User’s Manual...
  • Page 50: Failover (Ha-Cluster) Feature

    SMSEagle NXS-family devices have their own failover mechanism based on HA-cluster. This feature allows you to assure high availability of SMSEagle devices in critical environments. To enable failover (HA-cluster) you need 2 devices ('aka' nodes). The failover feature monitors devices working in the cluster, and detects faults with the following services: 1.
  • Page 51 When the daemon running at MASTER device detects failure of at least one described feature it immediately automatically switches cluster's IP assignment to the BACKUP device (node) providing continuous usage of the SMSEagle HA-cluster for the user. Devices (nodes) should see each other on the network. By default, HA-nodes use 224.0.0.18 multicast IP address for VRRP (Virtual Router Redundancy Protocol) for communication between two nodes.
  • Page 52 Failover feature uses KEEPALIVED-MIB for SNMP monitoring. DEVICE CLUSTER STATE EXAMPLE OF READING VALUE USING NET-SNMP LIBRARY a) Command for reading the result value: snmpget -v 2c -c public ip-of-smseagle .1.3.6.1.4.1.9586.100.5.2.3.1.4.1 Result: KEEPALIVED-MIB::vrrpInstanceState.1 = INTEGER: master(2) Comment: Current device state is master | SMSEagle NXS-9700...
  • Page 53: 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.
  • Page 54 ICMP (ping) to monitor a server with ICMP protocol • or PORT (TCP/UDP) to monitor your service on a selected port (SMSEagle will check if port is open) • or SNMP to monitor objects via SNMP protocol (supported return types: numeric, string) •...
  • Page 55 MONITORING FREQUENCY Monitoring tasks are performed in a parallel mode. Software automatically optimizes number of parallel tasks and frequency of tasks taking into account the performance of the device and adjusts monitoring period when needed. | SMSEagle NXS-9700 | User’s Manual...
  • Page 56 What makes the Trap unique is that they are triggered instantaneously by an agent, rather than waiting for a status request from SNMP get query. Screenshot from Network Monitor > SNMP TRAPS window. | SMSEagle NXS-9700 | User’s Manual...
  • Page 57: Email To Sms Plugin

    The text of the email is the text of the SMS message (optionally you can append email subject at the beginning of SMS message). Example: email message sent to the address: 123456789@192.168.0.101 will be converted to SMS message and delivered to phone number 123456789. | SMSEagle NXS-9700 | User’s Manual...
  • Page 58 LDAP plugin must be configured on your SMSEagle device. USING FQDN IN EMAIL ADDRESS It is also possible to use Fully Qualified Domain Name in an email address sent to SMSEagle box (eg.: 123456789@mydomain.com). Please refer to our FAQ article:...
  • Page 59 Screenshot from Email To SMS > Rules window Screenshot from Email to SMS > Add new rule You can name your rule • You can set forwarding to Always or For specified senders / when email contains • | SMSEagle NXS-9700 | User’s Manual...
  • Page 60: Email To Sms Poller

    If you enabled contacts from LDAP, define Phone number for LDAP errors. Alerts about errors with • LDAP connection will be sent to this phone number after 3 unsuccessful LDAP connection attempts. Leave this field empty for not alerts Email to SMS Poller | SMSEagle NXS-9700 | User’s Manual...
  • Page 61 SMS message to +48333444555 mobile number. SEND TO USERNAME/GROUP If you want to send SMS to a contact or group from SMSEagle phonebook, put the contact/group name in SUBJECT field. Notice: Messages that are processed by Email2SMS Poller (but not deleted) are marked in the mailbox as read. Software is based on flagging messages- Read/Unread.
  • Page 62 Screenshot from Email to SMS Poller > Add new rule You can name your rule • You can set forwarding to Always or For specified senders / when email contains • | SMSEagle NXS-9700 | User’s Manual...
  • Page 63: Sms To Email Plugin

    If you want to send as MMS, select always or only when email contains an attachment • SMS to Email plugin SMS to Email plugin allows you to forward incoming SMS messages to email address. The plugin can be used in two modes: | SMSEagle NXS-9700 | User’s Manual...
  • Page 64 SMS to email of last sender (so called Two-way Email2SMS & SMS2Email) In this mode, when SMSEagle receives incoming SMS, it checks if earlier anyone was sending SMS to the number from incoming SMS using Emai2SMS. If last sender is found, the incoming SMS is forwarded to the email address of last sender.
  • Page 65 SMS (and phonebook contact name if found) • Date, time when SMS is received • SMS message • Example email text sent from plugin: From: +483334455 (John Doe) Received: 2017-06-01 14:38:12 Message: My SMS message | SMSEagle NXS-9700 | User’s Manual...
  • Page 66: Sms Forward

    • phone number or name of group from phonebook. User may define many forwarding rules in the plugin. • Each rule is processed independently. • There is a possibility to enable/disable each rule. • | SMSEagle NXS-9700 | User’s Manual...
  • Page 67: 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.
  • Page 68 After sending HTTP(S) GET/POST request to your callback URL, SMSEagle will be expecting HTTP response: 200 [OK]. If other or no response is received from your callback URL, SMSEagle will keep retrying every X minute for 24 hours. Retry interval can be set in main plugin Window: | SMSEagle NXS-9700 | User’s Manual...
  • Page 69: Periodic Sms

    Sending interval (Hourly, Daily, Weekly, Monthly or Annually) • Message type (SMS, USSD Code) • The content of the SMS text • The recipients (phone number(s) separated with comma or group(s) from phonebook) • | SMSEagle NXS-9700 | User’s Manual...
  • Page 70: Autoreply Plugin

    Plugin “Autoreply” allows to add many autoreply rules. Each rule can be enabled or disabled by user. Screenshot from plugin main window For each rule user can define: • When autoreply message should be sent: | SMSEagle NXS-9700 | User’s Manual...
  • Page 71: Digital Input/Output

    Screenshot form “Add/edit autoreply rule” Digital input/output The NXS- family of SMSEagle devices is equipped with digital inputs (DI) and digital outputs (DO). The digital inputs can be used to receive signals from outside sensors or devices and automatically trigger sending of SMS message based on input state.
  • Page 72 Port type Hardware Rev.3 Hardware Rev.2, Rev.1 The logical states of inputs and outputs of SMSEagle NXS-family of devices are represented by the following states: Logical level Hardware Rev.3 Hardware Rev. 2, Rev.1 LOW (0) +5 V HIGH (1) +5 V...
  • Page 73 Digital Output - example of usage with external relay Digital USING DIGITAL INPUTS Digital inputs (DI) of SMSEagle device are of type “pull-up resistor”. This type of input is used to prevent accidental switching of digital circuits. In order to achieve it any unconnected inputs called “floating inputs”...
  • Page 74 Digital Input - connection example with a device with 24V output DI/DO PLUGIN CONFIGURATION The plugin “Digital input/output” allows you to define rules that control the behaviour of digital inputs/outputs on SMSEagle device. User may define several processing rules for both inputs and outputs. | SMSEagle NXS-9700 | User’s Manual...
  • Page 75 The recipient’s name from phonebook • Alert timeout. This value defines time between consecutive alerts. If the value is set and input is • triggered several times during the timeout, only one alert message will be sent | SMSEagle NXS-9700 | User’s Manual...
  • Page 76 SMS text contains given value) State of output signal that will be triggered by incoming SMS message • Output signal duration in seconds (0 = without time limit) • Output signal delay before signal is set • | SMSEagle NXS-9700 | User’s Manual...
  • Page 77: Temperature & Humidity Sensors

    ±0.5°C accuracy and humidity with ±2% RH accuracy. Additionally, NXS-97xx Rev.3 (and higher) devices also support external sensors via 1-Wire interface. A measured values from sensors can be displayed in web-gui of SMSEagle and used to trigger SMS message to single/many recipients.
  • Page 78 • Sensor (internal or external) • On what condition SMS alarm should be sent (temperature/humidity is higher/lower than given • value) SMS text • SMS recipient: contact name or group name from Phonebook • | SMSEagle NXS-9700 | User’s Manual...
  • Page 79 (in minutes). If external sensors are supported they can be added and defined here. Screenshot from “Settings” window READING TEMP/HUMIDITY VIA SNMP PROTOCOL Current temperature and humidity values from internal sensor can be also read via SNMP protocol. See chapter “SNMP agent” for detailed description. | SMSEagle NXS-9700 | User’s Manual...
  • Page 80: Ldap Plugin

    LDAP plugin The LDAP plugin allows to access Active Directory (hereinafter referred to as “AD”) and read contacts and groups in SMSEagle web-GUI. The plugin can work with either Active Directory or OpenLDAP protocol type. PLUGIN CONFIGURATION Choose “LDAP” from left side menu in SMSEagle web-GUI to access plugin configuration. After enabling the plugin, user needs to fill in all requested fields according to AD settings.
  • Page 81 Screenshot from “LDAP settings” window Click “Save” and “Test connection” to make sure that SMSEagle is connected with AD server. Screenshot showing successful connection to AD server. With connection established, AD contacts/groups suggestions are shown in selected modules of web-gui.
  • Page 82: 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 | SMSEagle NXS-9700 | User’s Manual...
  • Page 83 Screenshot from Blacklist > Define STOP word feature You may defined a STOP keyword. When incoming message contains the keyword then the sender • number will be automatically added to blacklist. | SMSEagle NXS-9700 | User’s Manual...
  • Page 84: Smseagle Api

    SMSEAGLE API SMSEagle has powerful built-in REST API functionalities. API is dedicated for integration of SMSEagle with any external system or application. Below you will find a detailed description of API functionalities. SMSEagle API supports both HTTP and HTTPS protocol.
  • Page 85 – minute, SS – second) test (optional parameter) 1 = simulate message sending. Messages with that parameter will not be added to outbox and they will return ID = 0 EXAMPLES: https://url-of-smseagle/http_api/send_sms? access_token=0005gOjCOlMH8F2x&to=1234567&message=mymessage https://url-of-smseagle/http_api/send_sms? access_token=0005gOjCOlMH8F2x&to=1234567&message=mymessage&date=20140115213 | SMSEagle NXS-9700 | User’s Manual...
  • Page 86 <error_text>Invalid Access token</error_text> <status>error</status> </xml> Response (when wrong parameters): <xml> <error_text>Wrong parameters</error_text> <status>error</status> </xml> Important notice: You must encode URL before sending it to gateway if you use national characters in SMS message text. | SMSEagle NXS-9700 | User’s Manual...
  • Page 87: Send Sms/Mms: Jsonrpc Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle recipient telephone number (or numbers separated with comma) message...
  • Page 88 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: | SMSEagle NXS-9700 | User’s Manual...
  • Page 89: Send Sms To A Group: Http Get Method

    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 –...
  • Page 90 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> | SMSEagle NXS-9700 | User’s Manual...
  • Page 91: Send Sms/Mms To A Group: Jsonrpc Method

    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 –...
  • Page 92 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"}} | SMSEagle NXS-9700 | User’s Manual...
  • Page 93: Send Sms To Contact: Http Get Method

    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.
  • Page 94 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> <status>ok</status> </xml> Response (when wrong logindata): <xml> <error_text>Invalid login or password</error_text> <status>error</status> | SMSEagle NXS-9700 | User’s Manual...
  • Page 95: Send Sms/Mms To Contact: Jsonrpc Method

    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...
  • Page 96 "params":{"access_token":"0005gOjCOlMH8F2x","contactname":"johndoe","messag e":"mymessage"}} {"method":"sms.send_tocontact", "params":{"access_token":"0005gOjCOlMH8F2x","contactname":"johndoe","messag e":"mymessage","date":"201401152132"}} {"method":"sms.send_tocontact", "params":{"access_token":"0005gOjCOlMH8F2x","contactname":"johndoe","messag e":"mymessage","highpriority":"1"}} EXAMPLE (MMS): {"method":"sms.send_togroup", "params":{"access_token":"0005gOjCOlMH8F2x","contactname":" johndoe″,"message":"My message","message_type":"mms", "attachments": [{ "content_type":"image/png", "content ":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAE(…)", }]}} RESPONSE: Response: {"result": "OK; ID=[ID of message in outbox]"} Sample response: {"result": "OK; ID=[297]"} | SMSEagle NXS-9700 | User’s Manual...
  • Page 97: Send Ussd Code: Http Get Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle USSD code (urlencoded) modem_no (optional parameter) sending modem number (only for multimodem devices)
  • Page 98 <status>error</status> </xml> Response (when wrong parameters): <xml> <error_text>Wrong parameters</error_text> <status>error</status> </xml> Important notice: You must urlencode USSD code before sending it to gateway. Response from cellular network will show up in device Inbox folder. | SMSEagle NXS-9700 | User’s Manual...
  • Page 99: Send Ussd Code: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle USSD code modem_no (optional parameter) sending modem number (only for multimodem devices)
  • Page 100: Send Binary Sms: Http Get Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle recipient telephone number (or numbers separated with comma) (optional parameter) UDH header for the message (in hex format)
  • Page 101: Send Binary Sms: Jsonrpc Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle recipient telephone number (or numbers separated with comma) (optional parameter) UDH header for the message (in hex format)
  • Page 102: Read Sms: Http Get Method

    {"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 | SMSEagle NXS-9700 | User’s Manual...
  • Page 103 Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems...
  • Page 104 <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 | SMSEagle NXS-9700 | User’s Manual...
  • Page 105 <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> | SMSEagle NXS-9700 | User’s Manual...
  • Page 106 <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> | SMSEagle NXS-9700 | User’s Manual...
  • Page 107 <Coding>Default_No_Compression</Coding> <UDH></UDH> <SMSCNumber></SMSCNumber> <Class>-1</Class> <TextDecoded>Test with bad phone number</TextDecoded> <ID>578</ID> <SenderID>smseagle2</SenderID> <SequencePosition>1</SequencePosition> <Status>SendingError</Status> <StatusError>-1</StatusError> <TPMR>-1</TPMR> <RelativeValidity>255</RelativeValidity> <CreatorID>admin</CreatorID> <id_folder>3</id_folder> <StatusCode>21</StatusCode> </item> </messages> <status>ok</status> </xml> Response (when no data): <xml> <error_text>No data to display</error_text> <status>error</status> </xml> | SMSEagle NXS-9700 | User’s Manual...
  • Page 108 SMS unique identification number RecipientID text which modem received the message (for example: smseagle1, smseagle2) Processed boolean whether SMS was processed by SMSEagle application id_folder integer identification of storage folder. Possible values: Inbox Trash 11… Custom folder readed text...
  • Page 109 SMS unique identification number SenderID character varying (255) which modem sent the message (for example: smseagle1, smseagle2) SequencePosition integer SMS number in SMS sequence Status character varying (255) Status of message sending. Possible values: SendingOK | SMSEagle NXS-9700 | User’s Manual...
  • Page 110: Read Sms/Mms: Jsonrpc Method

    > -1 CMS Error occurred. CMS error number is saved in this field. 12. Read SMS/MMS: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/jsonrpc/sms Parameter Description access_token authentication access token (see details in point API Authentication) | SMSEagle NXS-9700 | User’s Manual...
  • Page 111 SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems idfrom (optional parameter) minimal message-id idto (optional parameter) maximum message-id from (optional parameter) telephone number of SMS sender (for inbox)
  • Page 112 "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", | SMSEagle NXS-9700 | User’s Manual...
  • Page 113 "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", | SMSEagle NXS-9700 | User’s Manual...
  • Page 114 "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", | SMSEagle NXS-9700 | User’s Manual...
  • Page 115 "UpdatedInDB": "2020-12-18 16:52:32", "InsertIntoDB": "2020-12-18 16:52:16", "SendingDateTime": "2020-12-18 16:52:32", "DeliveryDateTime": null, "Text": "0054006500730074002000740065007300740031", "DestinationNumber": "+48601000310", "Coding": "Unicode_No_Compression", "UDH": "", "SMSCNumber": "", "Class": "100", "TextDecoded": "Test test1", "ID": "1174", "SenderID": "smseagle1", "SequencePosition": "1", "Status": "SendingOKNoReport", "StatusError": "-1", | SMSEagle NXS-9700 | User’s Manual...
  • Page 116 "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", "SenderNumber": "+48123456788", | SMSEagle NXS-9700 | User’s Manual...
  • Page 117 "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", "DestinationNumber": "+48123456789", | SMSEagle NXS-9700 | User’s Manual...
  • Page 118 "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" "UpdatedInDB": "2018-07-18 14:27:13", | SMSEagle NXS-9700 | User’s Manual...
  • Page 119 "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", "SenderID": "smseagle1", | SMSEagle NXS-9700 | User’s Manual...
  • Page 120 "id_folder": "3", "StatusCode": "200", "MMS_ID": "F9188B35A22EB175", "MMSHeaders": "", "MMSReports": null, "Attachments": [ "ContentType": "image/jpeg", "Content": "LzlqLzRBQVFTa1p" "ContentType": "image/gif", "Content": "UjBsR09EbGhaQUE" "status": "ok" Response (when no data): {"result": {"error_text":" No data to display ", "status":"error"}} | SMSEagle NXS-9700 | User’s Manual...
  • Page 121 SMS unique identification number RecipientID text which modem received the message (for example: smseagle1, smseagle2) Processed boolean whether SMS was processed by SMSEagle application id_folder integer identification of storage folder. Possible values: Inbox Trash 11… Custom folder readed text...
  • Page 122 SMS unique identification number SenderID character varying (255) which modem sent the message (for example: smseagle1, smseagle2) SequencePosition integer SMS number in SMS sequence Status character varying (255) Status of message sending. Possible values: SendingOK | SMSEagle NXS-9700 | User’s Manual...
  • Page 123 Field available when include_attachments parameter has been set to 1. Contains headers from MMS message. MMSReports text Field available when include_attachments parameter has been set to 1. Contains delivery report from MMSC for sent MMS messages. | SMSEagle NXS-9700 | User’s Manual...
  • Page 124: Delete Sms: Http Get Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems...
  • Page 125: Delete Sms: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems...
  • Page 126: Get Outgoing Queue Length: Http Get Method

    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...
  • Page 127: Get Outgoing Queue Length: Jsonrpc Method

    Description access_token authentication access token (see details in point API Authentication) Login your user to login to SMSEagle (see details in point API Authentication) Pass your password to login to SMSEagle Responsetype (optional parameter) simple = format response as simple object with one result...
  • Page 128: Get Inbox Length: Http Get Method

    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...
  • Page 129: 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 | SMSEagle NXS-9700 | User’s Manual...
  • Page 130: Get Sentitems Length: Http Get Method

    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...
  • Page 131 <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> | SMSEagle NXS-9700 | User’s Manual...
  • Page 132: Get Sentitems Length: Jsonrpc Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle responsetype (optional parameter) simple = format response as simple object with one result...
  • Page 133 Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in...
  • Page 134: Get 3G/4G Signal Strength: Jsonrpc Method

    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...
  • Page 135: Phonebook Group Create: Http Get Method

    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...
  • Page 136: Phonebook Group Create: Jsonrpc Method

    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...
  • Page 137: Phonebook Group Read: Http Get Method

    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...
  • Page 138 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): | SMSEagle NXS-9700 | User’s Manual...
  • Page 139: Phonebook Group Read: Jsonrpc Method

    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...
  • Page 140: Phonebook Group Update: Http Get Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group groupname name for the group...
  • Page 141 Response (when wrong parameters): <xml> <error_text>Wrong or missing >>groupname<< parameter</error_text> <status>error</status> </xml> <xml> <error_text>Wrong or missing >>group_id<< parameter</error_text> <status>error</status> </xml> Response (when group_id is wrong): <xml> <error_text>Group with the given id does not exists</error_text> <status>error</status> </xml> | SMSEagle NXS-9700 | User’s Manual...
  • Page 142: Phonebook Group Update: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group groupname name for the group...
  • Page 143: Phonebook Group Delete: Http Get Method

    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...
  • Page 144: Phonebook Group Delete: Jsonrpc Method

    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...
  • Page 145: Phonebook Group Add Contact: Http Get Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact.
  • Page 146 Response (when wrong parameters): <xml> <error_text>Wrong or missing >>group_id<< parameter</error_text> <status>error</status> </xml> <xml> <error_text>Wrong or missing >>contact_id<< parameter</error_text> <status>error</status> </xml> Response (when id is wrong): <xml> <error_text>Group with the given id does not exists</error_text> <status>error</status> </xml> | SMSEagle NXS-9700 | User’s Manual...
  • Page 147: Phonebook Group Add Contact: Jsonrpc Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact.
  • Page 148: Phonebook Group Remove Contact: Http Get Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact.
  • Page 149 <error_text>Wrong or missing >>contact_id<< parameter</error_text> <status>error</status> </xml> Response (when id is wrong): <xml> <error_text>Group with the given id does not exists</error_text> <status>error</status> </xml> <xml> <error_text>Contact with the given id does not exists</error_text> <status>error</status> </xml> | SMSEagle NXS-9700 | User’s Manual...
  • Page 150: Phonebook Group Remove Contact: Jsonrpc Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact.
  • Page 151: Phonebook Contact Create: Http Get Method

    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...
  • Page 152: Phonebook Contact Create: Jsonrpc Method

    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...
  • Page 153: Phonebook Contact Read: Http Get Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle public (optional parameter) 0 = private contacts (default value), 1 = public contacts...
  • Page 154 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> | SMSEagle NXS-9700 | User’s Manual...
  • Page 155: Phonebook Contact Read: Jsonrpc Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle public (optional parameter) 0 = private contacts (default value), 1 = public contacts...
  • Page 156 {"result": "Wrong or missing >>public<< parameter"} RESPONSE (EXTENDED): Sample response: {"result":{"contacts":[ {"ID":"2","GroupID":"-1","Name":"John Doe","Number":"123123123","id_user":"1","is_public":"false"}, {"ID":"4","GroupID":"-1","Name":"Jan Nowak","Number":"4215456456","id_user":"1","is_public":"false"}, {"ID":"5","GroupID":"- 1","Name":"Andy","Number":"+441234155931","id_user":"1","is_public":"false" ],"status":"ok"}} Response (when no data): {"result": {"error_text":" No data to display","status":"error"}} Response (when wrong logindata): {"result": {"error_text":"Invalid login or password","status":"error"}} | SMSEagle NXS-9700 | User’s Manual...
  • Page 157: Phonebook Contact Update: Http Get Method

    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...
  • Page 158: Phonebook Contact Update: Jsonrpc Method

    <xml> <error_text>Wrong or missing >>number<< parameter</error_text> <status>error</status> </xml> Response (when contact_id is wrong): <xml> <error_text>Contact with the given id does not exists</error_text> <status>error</status> </xml> 40. Phonebook contact update: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/jsonrpc/sms | SMSEagle NXS-9700 | User’s Manual...
  • Page 159 Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name for the contact...
  • Page 160: Phonebook Contact Delete: Http Get Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
  • Page 161: Phonebook Contact Delete: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
  • Page 162: Call With Termination: Http Get Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle phone numer to call duration connection duration (in seconds)
  • Page 163 <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> | SMSEagle NXS-9700 | User’s Manual...
  • Page 164: Call With Termination: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle phone numer to call duration connection duration (in seconds)
  • Page 165: Phonebook Shift Create: Http Get Method

    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...
  • Page 166: 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 | SMSEagle NXS-9700 | User’s Manual...
  • Page 167: Phonebook Shift Read: Http Get Method

    47. Phonebook shift read: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/http_api/shift_read Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) | SMSEagle NXS-9700 | User’s Manual...
  • Page 168 SMSEagle name (optional parameter) shift name enabled (optional parameter) 0 = disabled, 1 = enabled shift_id (optional parameter) shift id responsetype (optional parameter) text = format response as text (default), xml = format response as XML object...
  • Page 169: Phonebook Shift Read: Jsonrpc Method

    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...
  • Page 170 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, | SMSEagle NXS-9700 | User’s Manual...
  • Page 171: Phonebook Shift Update: Http Get Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift name name for the shift...
  • Page 172 Response (when wrong parameters): <xml> <error_text>Wrong or missing >>name<< parameter</error_text> <status>error</status> </xml> <xml> <error_text>Wrong or missing >>shift_id<< parameter</error_text> <status>error</status> </xml> Response (when shift_id is wrong): <xml> <error_text>Shift with given id does not exists</error_text> <status>error</status> | SMSEagle NXS-9700 | User’s Manual...
  • Page 173: Phonebook Shift Update: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift name name for the shift...
  • Page 174: Phonebook Shift Delete: Http Get Method

    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...
  • Page 175: Phonebook Shift Delete: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift responsetype (optional parameter) simple = format response as simple object with one result...
  • Page 176: Phonebook Shift Add Contact: Http Get Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) contact_id id of contact.
  • Page 177 <error_text>Wrong or missing >>contact_id<< parameter</error_text> <status>error</status> </xml> Response (when id is wrong): <xml> <error_text>Shift with the given id does not exists</error_text> <status>error</status> </xml> <xml> <error_text>Contact with the given id does not exists</error_text> <status>error</status> </xml> | SMSEagle NXS-9700 | User’s Manual...
  • Page 178: Phonebook Shift Add Contact: Jsonrpc Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) contact_id id of contact.
  • Page 179: Phonebook Shift Remove Contact: Http Get Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) contact_id id of contact.
  • Page 180: Phonebook Shift Remove Contact: Jsonrpc Method

    Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) | SMSEagle NXS-9700 | User’s Manual...
  • Page 181: Get Modem State: Http Get Method

    Response (when id is wrong): {"result": {"error_text":"Shift with the given id does not exists","status":"error"}} {"result": {"error_text":"Contact with the given id does not exists","status":"error"}} 57. Get modem state: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/http_api/get_modem_state Parameter Description | SMSEagle NXS-9700 | User’s Manual...
  • Page 182 (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in...
  • Page 183: Get Modem State: Jsonrpc Method

    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...
  • Page 184: Set Modem State: Http Get Method

    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...
  • Page 185: Set Modem State: Jsonrpc Method

    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...
  • Page 186: User Id Read: Http Get Method

    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...
  • Page 187: User Id Read: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle username username to be queried responsetype (optional parameter) simple = format response as simple object with one result...
  • Page 188: Group Members Read: Http Get Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id ID of group to be queried user_id...
  • Page 189: Group Members Read: Jsonrpc Method

    <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 | SMSEagle NXS-9700 | User’s Manual...
  • Page 190 Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle group_id ID of group to be queried user_id...
  • Page 191: Call Forward Read: Http Get Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no modem number (default = 1) responsetype...
  • Page 192: Call Forward Read: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no modem number (default = 1) responsetype...
  • Page 193: Call Forward Set: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle modem_no modem number (default = 1) status status of call forwarding 0 = disabled, 1 = enabled...
  • Page 194: Phonebook Contact Set Vacation Mode: Http Get Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
  • Page 195: Phonebook Contact Set Vacation Mode: Jsonrpc Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
  • Page 196: Phonebook Contact Get Vacation Mode: Http Get Method

    Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
  • Page 197: Phonebook Contact Get Vacation Mode: Jsonrpc Method

    </vacation_mode> <status> </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> 72. Phonebook contact get vacation mode: JSONRPC method | SMSEagle NXS-9700 | User’s Manual...
  • Page 198 Parameter Description access_token authentication access token (see details in point API Authentication) login your user to login to SMSEagle (see details in point API Authentication) pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact...
  • Page 199: 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: https://www.smseagle.eu/integration-plugins/...
  • Page 200: Extras

    EXTRAS Delivery Reports SMSEagle software allows you to enable delivery reports for each sent SMS. Delivery reports is afeature that allows to receive a confirmation that SMS was received on recipients phone. In order to enable delivery reports, please go to web-GUI > menu Settings and set “Delivery Reports” to “Yes”...
  • Page 201: Injecting Short Sms Using Sql

    Once database access isenabled, it is possible to connect to the database from external application using the following credentials: OSTGRE DATABASE CREDENTIALS Host: IP address of your device Database name: smseagle User: smseagleuser Password: postgreeagle Injecting short SMS using SQL The simplest example is short text message (limited to 160 chars):...
  • Page 202: Injecting Long Sms Using Sql

    INSERT INTO outbox_multipart ( "ID", "SequencePosition", "UDH", "TextDecoded", "Coding", "Class" ) SELECT CURRVAL(pg_get_serial_sequence('outbox','ID')), '050003D30202', 's nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.', 'Default_No_Compression', INSERT INTO user_outbox ( id_outbox, id_user ) SELECT | SMSEagle NXS-9700 | User’s Manual...
  • Page 203 CURRVAL(pg_get_serial_sequence('outbox','ID')), Note: Adding UDH means that you have less space for text, in above example you can use only 153 characters in single message. | SMSEagle NXS-9700 | User’s Manual...
  • Page 204: Database Cleaning Scripts

    1) Create a file inside /etc/cron.d/ directory with your desired name (eg. pico db_cleaner) 2) Example content of this file: 0 0 1 * * root /mnt/nand-user/scripts/db_delete_allfolders This will run cleaning script every 1 day of month. | SMSEagle NXS-9700 | User’s Manual...
  • Page 205: Snmp Agent

    It is used mostly in network management systems to monitor network-attached devices for conditions that warrant administrative attention” (source: Wikipedia). SMSEagle device has a built-in Net-SNMP agent. The SNMP agent provides access to Linux Host MIB tree of the device, and additionally (using extension NET-SNMP-EXTEND-MIB) allows access to custom metrics specific to SMSEagle.
  • Page 206 -v 2c -c public localhost .1.3.6.1.4.1.8072.1.3.2.3.1.2.11.71.83.77.95.83.105.103.110.97.108.49 Result: NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_Signal" = STRING: 54 Comment: GSM/3G/4G Signal strength value is 54% EXAMPLE OF READING GSM_NETNAME1 VALUE USING NET-SNMP LIBRARY a) Command for reading the result value: | SMSEagle NXS-9700 | User’s Manual...
  • Page 207 DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (216622) 0:36:06.22 Comment: Linux system is up for 36 hours, 6.22 minutes EXAMPLE OF BROWSING SMSEAGLE EXTENSION PARAMETERS IN MIB TREE USING NET-SNMP LIBRARY a) Command for reading the result value: snmpwalk -v 2c -c public ip-of-smseagle .1.3.6.1.4.1.8072.1.3.2.3.1.2 Result: NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_Signal"...
  • Page 208: Setting Up Snmp V3 Access Control

    EXAMPLE OF BROWSING SMSEAGLE EXTENSION PARAMETERS IN MIB TREE USING MIB-BROWSER Setting up SNMP v3 access control By default, SMSEagle devices uses SNMP v2 access control. Using v3 can strengthen security, however is not mandatory. To easily switch to SNMP v3 access control we’ve prepared special shell script located at /mnt/nand-user/smseagle directory.
  • Page 209 7. To disable v2 access policy run: ./snmpv3 disablev2 8. To enable v2 access policy run: ./snmpv3 enablev2 | SMSEagle NXS-9700 | User’s Manual...
  • Page 210: Forwarding Logs To External 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: https://www.rsyslog.com/doc/v8-stable/tutorials/tls_cert_summary.html | SMSEagle NXS-9700 | User’s Manual...
  • Page 211: Automatic Software Updates Check

    (if the phone number is entered in the account) with a notification about new software update. Screenshot from “General settings-Maintenance” Notice: Your SMSEagle device must have a HTTPS connectivity with address www.smseagle.eu in order for this feature to work. | SMSEagle NXS-9700...
  • Page 212: Knowledgebase & Support Portal

    Knowledgebase & Support Portal More information and useful hints about SMSEagle device configuration can be found in our online knowledgebase and support portal at: https://support.smseagle.eu | SMSEagle NXS-9700 | User’s Manual...
  • Page 213 I I I TROUBLESHOOTING | SMSEagle NXS-9700 | User’s Manual...
  • Page 214: Troubleshooting

    In case of any problems with the device these logs are a valuable source of troubleshooting information. Extended device logs can be downloaded via button “Download device logs” in menu “Settings” > “Sysinfo”. | SMSEagle NXS-9700 | User’s Manual...
  • Page 215: When The Device Is Not Reachable

    Restore service is counting button for 10 seconds down. System is reading factory 3. Release SW button defaults. after 10 seconds. User LED will begin to Factory settings are being blink. applied to the device. | SMSEagle NXS-9700 | User’s Manual...
  • Page 216 System is going for a reboot. reboots. Default settings are restored. Please note, that after reboot the device will be finishing the process of factory reset, therefore it can take longer for the system to start. | SMSEagle NXS-9700 | User’s Manual...
  • Page 217 SERVICE & REPAIR | SMSEagle NXS-9700 | User’s Manual...
  • Page 218: Service & Repair

    Go to menu Settings > Sysinfo > “Download device logs”. Provide log package to support team when requested. MAC address Each SMSEagle device has its unique MAC address. MAC address is printed on the device body or can be found in menu Settings > IP Settings | SMSEagle NXS-9700...
  • Page 219 TECH SPECS & SAFETY INFORMATION | SMSEagle NXS-9700 | User’s Manual...
  • Page 220: Tech Specs & Safety Information

    RTC Clock: RTC 240B SRAM, Watchdog timer • Internal humidity & temperature sensor: Accuracy ± 0,5 °C, ±2 %RH • Power consumption: • hardware Rev.4: max 25W hardware Rev.3-Rev.1: max 12W Noise level: Fan-less • | SMSEagle NXS-9700 | User’s Manual...
  • Page 221 LTE TDD: 38, 40, 41 3G Bands: 1, 2, 4, 5, 8 Output power: Class 3 (0.2 W, 23 dBm) @ LTE  Class 3 (0.25 W, 23 dBm) @ 3G  Device type NXS-9700-3G Rev.3 – Rev.1: | SMSEagle NXS-9700 | User’s Manual...
  • Page 222 Voltage ranges: 100–240V alternating current (AC)  Frequency: 50–60Hz single phase  DC plug type: 5.5/2.5  ANTENNA Device type NXS-9700-3G: • Omnidirectional 3dBi antenna with magnetic foot Waveband: GSM, UMTS Cable length 3m | SMSEagle NXS-9700 | User’s Manual...
  • Page 223 • 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 modem • modern responsive web interface • | SMSEagle NXS-9700 | User’s Manual...
  • Page 224: Important Safety Information

    SAR regulation. DISCLAIMER: The manufacturer is not responsible for any damages caused by inappropriate installation, not maintaining the proper technical condition or using a product against its destination. | SMSEagle NXS-9700 | User’s Manual...
  • Page 225: Regulatory Statements

    REGULATORY STATEMENTS EU Declaration of Conformity Hereby, Proximus Sp. z o.o., owner of SMSEagle brand, declares that the radio equipment type SMSEagle NXS-9700-3G, NXS-9700-4G is in compliance with Directive 2014/53/EU. The full text of the EU declaration of conformity is available at the following internet address: www.smseagle.eu/certification...
  • Page 226: Canadian Regulatory Statement

    CAN ICES-3 (B)/NMB-3(B) UK Declaration of Conformity Hereby, Proximus Sp. z o.o., owner of SMSEagle brand, declares that the radio equipment type SMSEagle NXS-9700-3G, NXS-9700-4G is in compliance with The Radio Equipment Regulations 2017. The full text of the EU declaration of conformity is available at the following internet address: www.smseagle.eu/certification...
  • Page 227: Disposal And Recycling Information

    Disposal and Recycling Information Your SMSEagle device contains lithium battery for RTC backup. Dispose of the device and/or battery in accordance with local environmental laws and guidelines. European Union—Disposal Information The symbol above means that according to local laws and regulations your product shall be disposed of separately from household waste.
  • Page 228: Restriction Of Hazardous Substances Directive (Rohs)

    Restriction of Hazardous Substances Directive (RoHS) European Union RoHS SMSEagle devices sold in the European Union, on or after 3 January 2013 meet the requirements of Directive 2015/863 on the restriction of the use of certain hazardous substances in electrical and electronic equipment (“RoHS 3”).
  • Page 229 Proximus Sp. z o.o. Ul. Piątkowska 163, 60-650 Poznań, Poland l Europe T +48 61 6713 413 E hello@smseagle.eu www.smseagle.eu | SMSEagle NXS-9700 | User’s Manual...

This manual is also suitable for:

Nxs-9700-4g

Table of Contents