SMSEagle NXS-9750-3G User Manual
  1. Manuals
  2. Brands
  3. SMSEagle Manuals
  4. Gateway
  5. NXS-9750-3G
  6. User manual

SMSEagle NXS-9750-3G User Manual

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

Advertisement

Quick Links

SMSEAGLE
NXS-9750-3G
NXS-9750-4G
User's Manual

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Related Manuals for SMSEagle NXS-9750-3G

Summary of Contents for SMSEagle NXS-9750-3G

  • Page 1 SMSEAGLE NXS-9750-3G NXS-9750-4G 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 are subject Document version: 4.0 to change without prior notice being given.

  • Page 3: Table Of Contents

    CONTENTS SMSEagle Software Licensing Information ......................9 What’s In The Box ..............................15 Prepare for First Start ............................. 16 Get to know with Connectors, Ports and LEDs ....................21 Basic Operations ..............................22 SMSEagle basic features ............................23 Compose SMS ............................... 23 Folders ..................................
  • Page 4 Temperature & humidity sensor ........................63 LDAP plugin ................................66 Blacklist .................................. 67 Multimodem features ............................. 69 SMSEagle API ................................70 0. API Authentication ............................70 1. Send SMS: HTTP GET method ........................70 2. Send SMS/MMS: JSONRPC method ......................73 3.
  • Page 5 16. Get outgoing queue length: JSONRPC method ................. 113 17. Get inbox length: HTTP GET method ....................114 18. Get inbox length: JSONRPC method ..................... 115 19. Get sentitems length: HTTP GET method ..................116 20. Get sentitems length: JSONRPC method .................... 118 21.
  • Page 6 64. Group members read: JSONRPC method.................... 175 Plugins and integration manuals for NMS & Auth systems ..............178 Extras ..................................179 Connecting directly to SMSEagle database .................... 179 Injecting short SMS using SQL ........................179 Injecting long SMS using SQL ........................180 Database cleaning scripts ..........................
  • Page 7 Verification of LEDs ............................190 Checking the device information ........................190 Device logs ................................190 When the device is not reachable ........................ 191 Restoring factory defaults ..........................191 Service & Repair..............................194 Warranty ................................194 Service ................................. 194 Tech Specs & Safety Information ........................196 Technical Specification ............................
  • Page 8 GET READY TO START | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 9: 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 10 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 11 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 12 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 13 Agricultural Chamber of the Czech Republic according to its Rules by one arbitrator appointed by the President of the Arbitration Court. 9.07 ASSIGNMENTS. You may not transfer the SMSEagle device on which SMSEagle Software is installed unless the transferee agrees to the terms of this Agreement. 9.08 VALID AND BINDING.
  • Page 14 CONTACT INFORMATION If you have questions regarding this EULA, please contact PROXIMUS at: 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-9750 | User’s Manual...

  • Page 15: What's In The Box

    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 • | SMSEagle NXS-9750 | User’s Manual...

  • Page 16: 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 antennas STEP 1: ANTENNA INSTALLATION GUIDELINES Install antennas in a location with access to a cellular network radio signal.
  • Page 17 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 18 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 19 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.
  • Page 20 USING OF SMSEAGLE | SMSEagle NXS-9750 | User’s Manual...

  • Page 21: Get To Know With Connectors, Ports And Leds

    SIM1,2 LEDs Modem 1,2 (optional) LED indicator for modem status (only in 3G devices) Ready LED LED indication device status Reset Switch for rebooting the device User Switch Switch for restoring to factory settings | SMSEagle NXS-9750 | User’s Manual...

  • Page 22: 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 23: 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 24: Folders

    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: Table view type: | SMSEagle NXS-9750 | User’s Manual...

  • Page 25: Mms

    To view an MMS attachment, you need to click “show MMS attachment” in the inbox message. 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.

  • Page 26: Phonebook Groups

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

  • Page 27: Users

    • 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. Screenshot of Edit/Add User window | SMSEagle NXS-9750 | User’s Manual...

  • Page 28: Reporting Module

    PDF or CSV file. Screenshot of Reporting module Statistics view The reporting module allows also to view daily statistics of sent/received messages. The statistics view displays number of messages per day and sender/receiver number. | SMSEagle NXS-9750 | User’s Manual...

  • Page 29: Settings

    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” • | SMSEagle NXS-9750 | User’s Manual...

  • Page 30: Ip Settings

    You can input the IP address • You can input the Subnet Mast • You can set the Gateway IP Address • You can set DNS 1 • You can optionally set DNS 2 • | SMSEagle NXS-9750 | User’s Manual...

  • Page 31: Failover

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

  • Page 32: 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-9750 | User’s Manual...

  • Page 33: Data Connection

    You can input MMS autoresponder message • *The values for all fields can be found on the website of your SIM-card operator* Data connection Data connection settings can be accessed under the Settings tab > Data conn. | SMSEagle NXS-9750 | User’s Manual...

  • Page 34: Backup/Restore

    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 35: Updates

    Update setings can be accessed under the Settings tab > Updates. 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 36: Failover (Ha-Cluster) Feature

    Screenshot from “General Settings-Maintenance” Notice: Your SMSEagle device must have a HTTPS connectivity with address updates.smseagle.eu in order for this feature to work. 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.
  • Page 37 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 38 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-9750...

  • Page 39: 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 40 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 41 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-9750 | User’s Manual...
  • Page 42 SNMP trap is a popular mechanism used to manage and monitor devices’ activities via SNMP protocol. 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-9750 | User’s Manual...

  • Page 43: 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-9750 | User’s Manual...
  • Page 44 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.: 123456789@mydomain.com). Please refer to our FAQ article: How do I configure Email2SMS plugin to accept FQDN email addresses for more details.
  • Page 45 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 • You can choose sending modem no. • | SMSEagle NXS-9750 | User’s Manual...

  • Page 46: Email To Sms Poller

    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 | SMSEagle NXS-9750 | User’s Manual...
  • Page 47 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 48 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 • You can choose sending modem no. • | SMSEagle NXS-9750 | User’s Manual...

  • Page 49: 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-9750 | User’s Manual...
  • Page 50 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 51 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-9750 | User’s Manual...

  • Page 52: 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-9750 | User’s Manual...

  • Page 53: 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 54 ‘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’...

  • Page 55: Periodic Sms

    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: Periodic SMS The plugin “Periodic SMS”...

  • Page 56: Autoreply Plugin

    • Message type (SMS, USSD Code) • The content of the SMS text • The recipients (phone number(s) separated with comma or group(s) from phonebook) • Screenshot from “Add new rule” window Autoreply plugin | SMSEagle NXS-9750 | User’s Manual...
  • Page 57 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. | SMSEagle NXS-9750 | User’s Manual...

  • Page 58: 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 59 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”...
  • Page 60 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 | SMSEagle NXS-9750 | User’s Manual...
  • Page 61 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...
  • Page 62 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-9750 | User’s Manual...

  • Page 63: 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.
  • Page 64 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 • | SMSEagle NXS-9750 | User’s Manual...
  • Page 65 (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. | SMSEagle NXS-9750 | User’s Manual...

  • Page 66: 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 67: 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-9750 | User’s Manual...
  • Page 68 Screenshot from Blacklist > Define STOP word feature | SMSEagle NXS-9750 | User’s Manual...

  • Page 69: Multimodem Features

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

  • Page 70: 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. Please note, that SMSEagle API supports both HTTP and HTTPS protocol.
  • Page 71 – 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-9750 | User’s Manual...
  • Page 72 <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-9750 | User’s Manual...

  • Page 73: 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 your SMS message (optional parameter) date and time in format YYYYmmDDHHMM (YYYY –...
  • Page 74 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-9750 | User’s Manual...

  • Page 75: 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 76 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-9750 | User’s Manual...

  • Page 77: 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 78 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-9750 | User’s Manual...

  • Page 79: 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 80 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-9750 | User’s Manual...

  • Page 81: 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 82 "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-9750 | User’s Manual...

  • Page 83: 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 84 <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-9750 | User’s Manual...

  • Page 85: 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 86: 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 87: 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 88: 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-9750 | User’s Manual...
  • Page 89 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 90 <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-9750 | User’s Manual...
  • Page 91 <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-9750 | User’s Manual...
  • Page 92 <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-9750 | User’s Manual...
  • Page 93 <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-9750 | User’s Manual...
  • Page 94 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 95 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 | SMSEagle NXS-9750 | User’s Manual...

  • Page 96: Read Sms/Mms: 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 | SMSEagle NXS-9750 | User’s Manual...
  • Page 97 Show messages from inbox folder with sender phone number +481234567: {"method":"sms.read_sms", "params":{"access_token":"0005gOjCOlMH8F2x","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": "0005gOjCOlMH8F2x","folder":"sentitems","to":"7654321","datefrom":"20141224 081000","dateto":"20141231235959"}} | SMSEagle NXS-9750 | User’s Manual...
  • Page 98 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 | SMSEagle NXS-9750 | User’s Manual...
  • Page 99 "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" | SMSEagle NXS-9750 | User’s Manual...
  • Page 100 "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", | SMSEagle NXS-9750 | User’s Manual...
  • Page 101 "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", "TPMR": "-1", "RelativeValidity": "255", "CreatorID": "admin", "id_folder": "3", | SMSEagle NXS-9750 | User’s Manual...
  • Page 102 "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", "Coding": "Default_No_Compression", "UDH": "", "SMSCNumber": "+48790998250", "Class": "-1", "TextDecoded": "Test 2", | SMSEagle NXS-9750 | User’s Manual...
  • Page 103 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", "Coding": "Default_No_Compression", "UDH": "", "SMSCNumber": "+48501200777", "Class": "-1", "TextDecoded": "test", | SMSEagle NXS-9750 | User’s Manual...
  • Page 104 "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", "InsertIntoDB": "2018-07-18 14:27:03", "SendingDateTime": "2018-07-18 14:27:13", "DeliveryDateTime": null, | SMSEagle NXS-9750 | User’s Manual...
  • Page 105 "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", | SMSEagle NXS-9750 | User’s Manual...
  • Page 106 "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"}} Response (when wrong logindata): {"result": {"error_text":"Invalid login or password","status":"error"}} | SMSEagle NXS-9750 | User’s Manual...
  • Page 107 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 108 (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 | SMSEagle NXS-9750 | User’s Manual...
  • Page 109 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-9750 | User’s Manual...

  • Page 110: 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 111: 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 112: 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 113: 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 114: 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 115: 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-9750 | User’s Manual...

  • Page 116: 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 117 <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-9750 | User’s Manual...

  • Page 118: 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 119 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 120: Get Gsm/3G 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 121: 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 122: 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 123: 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 124 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-9750 | User’s Manual...

  • Page 125: 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 126: 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 127 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-9750 | User’s Manual...

  • Page 128: 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 129: 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 130: 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 131: 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 132 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-9750 | User’s Manual...

  • Page 133: 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 134: 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 135 <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-9750 | User’s Manual...

  • Page 136: 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 137: 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 138: 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 139: 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 140 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-9750 | User’s Manual...

  • Page 141: 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 142 {"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-9750 | User’s Manual...

  • Page 143: 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 144: 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-9750 | User’s Manual...
  • Page 145 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 146: 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 147: 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 148: 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 149 <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-9750 | User’s Manual...

  • Page 150: 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 151: 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 152: 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-9750 | User’s Manual...

  • Page 153: 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-9750 | User’s Manual...
  • Page 154 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 155: 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 156 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-9750 | User’s Manual...

  • Page 157: 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 158 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-9750 | User’s Manual...

  • Page 159: 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 160: 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 161: 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) text = format response as text (default), xml = format...

  • Page 162: 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 163 <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-9750 | User’s Manual...

  • Page 164: 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 165: 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 166: 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-9750 | User’s Manual...

  • Page 167: 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-9750 | User’s Manual...
  • Page 168 (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 169: 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 170: 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 171: 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 172: 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 173: 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) text = format response as text (default), xml = format...

  • Page 174: 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 175: 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-9750 | User’s Manual...
  • Page 176 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 177 {"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"}} Response (when wrong user_id parameter): {"result": "Wrong >>user_id<< parameter"} Response (when wrong public parameter): {"result": "Wrong >>public<< parameter"} | SMSEagle NXS-9750 | User’s Manual...

  • Page 178: 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 179: Extras

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

  • Page 180: Injecting Long Sms Using Sql

    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.
  • Page 181 'Default_No_Compression', INSERT INTO user_outbox ( id_outbox, id_user ) SELECT 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-9750 | User’s Manual...

  • Page 182: 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-9750 | User’s Manual...

  • Page 183: 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 184 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: 3G/4G Signal strength value is 54% | SMSEagle NXS-9750 | User’s Manual...
  • Page 185 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 186: 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 187: 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-9750 | User’s Manual...

  • Page 188: Automatic Software Updates Checks

    (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-9750...
  • Page 189 I I I TROUBLESHOOTING | SMSEagle NXS-9750 | User’s Manual...

  • Page 190: 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-9750 | User’s Manual...

  • Page 191: 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-9750 | User’s Manual...
  • Page 192 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-9750 | User’s Manual...
  • Page 193 SERVICE & REPAIR | SMSEagle NXS-9750 | User’s Manual...

  • Page 194: 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-9750...
  • Page 195 TECH SPECS & SAFETY INFORMATION | SMSEagle NXS-9750 | User’s Manual...

  • Page 196: Tech Specs & Safety Information

    Dimensions: (width x depth x height) 35 x 120 x 101 mm • Weight: 350g • Casing: ABS, DIN rail installation • Operating parameters: • Operating temperature: 0 ~ 40°C Humidity: 8 ~ 90% RH (no condensation) | SMSEagle NXS-9750 | User’s Manual...
  • Page 197 2x Internal modem • Device type NXS-9750-3G: Waveband: GSM, UMTS GSM/GPRS quad-band 850/900/1800/1900 MHz UMTS 800/850/900/AWS 1700/1900/2100 MHz 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 ...
  • Page 198 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 • | SMSEagle NXS-9750 | User’s Manual...

  • Page 199: 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-9750 | User’s Manual...

  • Page 200: Regulatory Statements

    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.

  • Page 201: Canadian Regulatory Statement

    20 cm (8 inches) during normal operation. 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.

  • Page 202: 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 203 Ul. Piątkowska 163, 60-650 Poznań, Poland l Europe T +48 61 6713 413 E hello@smseagle.eu www.smseagle.eu | SMSEagle NXS-9750 | User’s Manual...

This manual is also suitable for:

Nxs-9750-4gNxs-9700-3gNxs-9700-4gMhd-8100-3gMhd-8100-4g

Table of Contents