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

SMSEagle NXS-9700 User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
SMSEAGLE
NXS-9700
User's Manual

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for SMSEagle NXS-9700

Summary of Contents for SMSEagle NXS-9700

  • Page 1 SMSEAGLE NXS-9700 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: 3.32 to change without prior notice being given.

  • Page 3: Table Of Contents

    What’s In The Box ..............................8 Prepare for First Start ............................... 9 Get to know with Connectors, Ports and LEDs ....................14 Basic Operations ..............................15 SMSEagle basic features ............................16 Phonebook ................................16 Phonebook Contacts ............................16 Phonebook Groups ............................17 Phonebook Working Shifts ...........................
  • Page 4 6. Send SMS to contact: JSONRPC method ....................49 7. Send USSD code: HTTP GET method ......................50 8. Send USSD code: JSONRPC method ......................52 9. Send binary SMS: HTTP GET method ......................52 10. Send binary SMS: JSONRPC method ....................... 54 11.
  • Page 5 36. Phonebook contact create: JSONRPC method ..................99 37. Phonebook contact read: HTTP GET method ..................100 38. Phonebook contact read: JSONRPC method ..................102 39. Phonebook contact update: HTTP GET method ................104 40. Phonebook contact update: JSONRPC method ................. 105 41.
  • Page 6 Extras ..................................137 Connecting directly to SMSEagle SQL database ..................137 Injecting short SMS using SQL ........................137 Injecting long SMS using SQL ........................138 Database cleaning scripts ..........................140 SNMP agent ............................... 141 Setting up SNMP v3 access control ......................144 Failover (HA-cluster) feature ........................
  • Page 7 GET READY TO START | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 8: What's In The Box

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

  • Page 9: 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 GSM/3G antenna STEP 1: ANTENNA INSTALLATION GUIDELINES Install the antenna in a location with access to a cellular network radio signal.
  • Page 10 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 11 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 12 If your SIM-card requires PIN number at startup, go to Settings > Maintenance Tab. Enter your PIN number in the field “SIM Card PIN” > Press “Save” button. Reboot the device STEP 6: Go to Settings > Maintenance Tab. Press Reboot button. | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 13 USING OF SMSEAGLE | SMSEagle NXS-9700-3G | User’s Manual...

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

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

  • Page 15: Basic Operations

    SMSEagle is capable to work in various screen resolutions, making it accessible for wide range of devices: computers, laptops, tablets, smartphones, etc. Open a web browser on your device, type in SMSEagle’s IP address (as set in previous chapter). At login screen type in your username/password. Default username and password is given in chapter Prepare for First Start.

  • Page 16: Smseagle Basic Features

    • 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 17: 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-9700-3G | User’s Manual...

  • Page 18: Reporting Module

    Screenshot of Reporting module Statistics view The reporting module allows also to view daily statistics of sent/received messages. The statistics view displays number of messages per day and sender/receiver number. Screenshot of Statistics view in Reporting module | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 19: 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 20: Network Monitoring Plugin

    Screenshot form “Add/edit autoreply rule” Network Monitoring plugin SMSEagle is equipped with network monitoring features. With that features you can monitor any device or service that has listening port open. SMSEagle Network Monitoring plugin sequentially controls availability of defined hosts/ports in Network Monitoring feature and sends defined SMS alert when port is unavailable/goes back to life.
  • Page 21 (e.g. when doing a machine upgrades) • Define what you want to monitor in each task choose a name for the task • enter a host (IP address or Hostname) • | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 22 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 23: 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-3G | User’s Manual...
  • Page 24 The db-admin group must be defined in your SMSEagle phonebook. USING FQDN IN EMAIL ADDRESS It is also possible to use Fully Qualified Domain Name in an email address sent to SMSEagle box (eg.: 123456789@mydomain.com). Please refer to our FAQ article:...
  • Page 25 ‘Maximum number of characters’. Maximum • allowed length of SMS message is 1300 characters if you want to include in SMS message special national characters (like ąäàöß 我) set “Unicode • encoding of SMS text” to ‘Yes’ | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 26: Email To Sms Poller

    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 27 SMS message is 1300 characters. If you want to include special national characters, enable "Unicode encoding of SMS text" • Choose protocol from IMAP or POP3 • Provide mailbox configuration (host, port, user, password, encryption settings) • | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 28: Sms To Email Plugin

    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 29 EMAIL TEXT FROM PLUGIN Email body from SMS To Email plugin contains: phone number from incoming SMS (and phonebook contact name if found) • Date, time when SMS is received • SMS message • | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 30: 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 31: Sms Forward

    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 2 minutes for 24 hours. SMS Forward The plugin “SMS forward”...

  • Page 32: Periodic Sms

    The plugin “Periodic SMS” allows to send SMS messages or USSD codes at a desired time interval. User may define many sending rules, and each rule will be processed independently. PLUGIN CONFIGURATION Plugin “Periodic SMS” allows to add many sending rules. Each rule can be enabled or disabled by user. | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 33: Digital Input/Output

    Screenshot from “Add new rule” window Digital input/output The NXS-family of SMSEagle devices is equipped with 2 digital inputs (DI) and 2 digital outputs (DO). The digital inputs can be used to receive signals from outside sensors or devices and automatically trigger sending of | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 34 SMS message based on input state. On the other hand the digital outputs may be used to activate external devices connected to the outputs when certain SMS messages are received by SMSEagle. The logical states of inputs and outputs of SMSEagle NXS-family of devices are represented by the following voltages:...
  • Page 35 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-3G | User’s Manual...

  • Page 36: 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 37 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-9700-3G | User’s Manual...
  • Page 38 Screenshot from “Add or edit rule” window PLUGIN CONFIGURATION - SETTINGS Tab “Settings” allows to control sensor settings. User may enable/disable sensor and set sensor reading period (in minutes). Screenshot from “Settings” window | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 39: Ldap Plugin

    SMSEagle web-GUI. PLUGIN CONFIGURATION Choose “LDAP” from left side menu in SMSEagle web-GUI to access plugin configuration. After enabling the plugin, user needs to fill in all requested fields according to AD settings. In the “AD phone attribute” field user needs to choose which phone attribute from AD will be shown in SMSEagle web-gui.
  • Page 40 Start typing any part of contact/group name or number to show AD contact suggestions. Type “LDAP” (case sensitive) to check all contacts listed in AD directory. Screenshot from “Compose” module with LDAP connection enabled LDAP directory suggestions can be used in “Compose”, “Autoreply” and “Digital input/output” modules. | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 41: Smseagle Api

    SMSEAGLE API SMSEagle has powerful built-in HTTP API functionalities. REST 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 42 <xml> <message_id>[ID of message in outbox]</message_id> <status>ok</status> </xml> Sample response: <xml> <message_id>297</message_id> <status>ok</status> </xml> Response (when wrong logindata): <xml> <error_text>Invalid login or password</error_text> <status>error</status> </xml> Response (when wrong parameters): <xml> <error_text>Wrong parameters</error_text> <status>error</status> </xml> | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 43: Send Sms: Jsonrpc Method

    2. Send SMS: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms PARAMETERS: Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle recipient telephone number (or numbers separated with comma) message your SMS message date (optional parameter) date and time in format YYYYmmDDHHMM (YYYY – year, mm –...

  • Page 44: Send Sms To A Group: Http Get Method

    Description login your user to login to SMSEagle 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 | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 45 Sample response: OK; ID=297 Response (when wrong logindata): Invalid login or password 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> | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 46: Send Sms To A Group: Jsonrpc Method

    SMSEagle pass your password to login to SMSEagle groupname group name defined in your SMSEagle Phonebook. The group must be defined as Public message your SMS message date (optional parameter) date and time in format YYYYmmDDHHMM (YYYY – year, mm –...

  • Page 47: Send Sms To Contact: Http Get Method

    SMSEagle pass your password to login to SMSEagle contactname contact name (or names separated by comma) defined in your SMSEagle Phonebook. Contacts must be defined as Public message your SMS message date (optional parameter) date and time in format YYYYmmDDHHMM (YYYY – year, mm –...
  • Page 48 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-3G | User’s Manual...

  • Page 49: Send Sms To Contact: Jsonrpc Method

    SMSEagle pass your password to login to SMSEagle contactname contact name defined in your SMSEagle Phonebook. The contact must be defined as Public message your SMS message date (optional parameter) date and time in format YYYYmmDDHHMM (YYYY – year, mm –...

  • Page 50: Send Ussd Code: Http Get Method

    7. Send USSD code: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/send_ussd Parameters: Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle USSD code (urlencoded) modem_no (optional parameter) sending modem number (only for multimodem devices) | SMSEagle NXS-9700-3G...
  • Page 51 <status>error</status> </xml> Response (when wrong parameters): <xml> <error_text>Wrong parameters</error_text> <status>error</status> </xml> Important notice: You must urlencode USSD code before sending it to gateway. Response from GSM/3G network will show up in device Inbox folder. | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 52: Send Ussd Code: Jsonrpc Method

    8. Send USSD code: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameters: Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle USSD code modem_no (optional parameter) sending modem number (only for multimodem devices) responsetype...
  • Page 53 PARAMETERS: Parameter Description login your user to login to SMSEagle 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) data binary message (in hex format)

  • Page 54: Send Binary Sms: Jsonrpc Method

    HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms PARAMETERS: Parameter Description login your user to login to SMSEagle 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) data...

  • Page 55: Read Sms: Http Get Method

    "status":"error"}} 11. Read SMS: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/read_sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems idfrom (optional parameter) minimal message-id...
  • Page 56 Response (when wrong logindata): Invalid login or password Response (when wrong parameters): Wrong parameters RESPONSE (XML): Sample response (inbox folder): <xml> <messages> <item> <UpdatedInDB>2018-07-17 15:11:31</UpdatedInDB> <ReceivingDateTime>2018-07-17 15:04:04</ReceivingDateTime> <Text>005400650073007400200031</Text> <SenderNumber>+48123456789</SenderNumber> <Coding>Default_No_Compression</Coding> <UDH></UDH> <SMSCNumber>+48790998250</SMSCNumber> <Class>-1</Class> <TextDecoded>Test 1</TextDecoded> <ID>124</ID> <RecipientID>smseagle1</RecipientID> <Processed>t</Processed> <id_folder>1</id_folder> | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 57 In ac felis urna. Phasellus eget leo a leo congue ultricies. Donec tincidunt volutpat arcu a commodo</TextDecoded> <ID>126</ID> <RecipientID>smseagle1</RecipientID> <Processed>t</Processed> <id_folder>1</id_folder> <readed>true</readed> <oid></oid> <Status>0</Status> </item> </messages> <status>ok</status> </xml> Sample response (sentitems folder): <xml> <messages> | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 58 <ID>525</ID> <SenderID>smseagle1</SenderID> <SequencePosition>1</SequencePosition> <Status>SendingOK</Status> <StatusError>-1</StatusError> <TPMR>-1</TPMR> <RelativeValidity>255</RelativeValidity> <CreatorID>admin</CreatorID> <id_folder>3</id_folder> <StatusCode>-1</StatusCode> </item> <item> <UpdatedInDB>2018-07-18 14:25:41</UpdatedInDB> <InsertIntoDB>2018-07-18 14:25:23</InsertIntoDB> <SendingDateTime>2018-07-18 14:25:28</SendingDateTime> <DeliveryDateTime>2018-07-18 14:25:28</DeliveryDateTime> <Text>0054006500730074002000740065007300740031</Text> <DestinationNumber>+48123456788</DestinationNumber> <Coding>Default_No_Compression</Coding> <UDH></UDH> <SMSCNumber>+48601000310</SMSCNumber> <Class>-1</Class> <TextDecoded>Test test1</TextDecoded> <ID>574</ID> <SenderID>smseagle1</SenderID> <SequencePosition>1</SequencePosition> <Status>DeliveryOK</Status> <StatusError>0</StatusError> <TPMR>84</TPMR> | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 59 <DeliveryDateTime></DeliveryDateTime> <Text>00540065007300740020006F006600200066006C0061007300680020006D006500730 073006100670065</Text> <DestinationNumber>123456788</DestinationNumber> <Coding>Default_No_Compression</Coding> <UDH></UDH> <SMSCNumber>+48601000310</SMSCNumber> <Class>0</Class> <TextDecoded>Test of flash message</TextDecoded> <ID>577</ID> <SenderID>smseagle2</SenderID> <SequencePosition>1</SequencePosition> <Status>SendingOK</Status> <StatusError>-1</StatusError> <TPMR>87</TPMR> <RelativeValidity>255</RelativeValidity> <CreatorID>admin</CreatorID> <id_folder>3</id_folder> <StatusCode>-1</StatusCode> </item> <item> <UpdatedInDB>2018-07-18 14:29:29</UpdatedInDB> <InsertIntoDB>2018-07-18 14:28:46</InsertIntoDB> <SendingDateTime>2018-07-18 14:29:29</SendingDateTime> <DeliveryDateTime></DeliveryDateTime> <Text>0054006500730074002000770069007400680020006200610064002000700068006F0 06E00650020006E0075006D006200650072</Text> <DestinationNumber>11</DestinationNumber> | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 60 ReceivingDateTime timestamp when SMS was received Text text SMS text encoded using hex values SenderNumber character varying(30) SMS sender number Coding character varying(255) SMS text coding. Possible values: ‘Default_No_Compression’, ‘Unicode_No_Compression’, ‘8bit’, ‘Default_Compression’, | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 61 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 62 SMS message id_folder integer identification of storage folder. Possible values: Sent items Trash 11… Custom folder StatusCode integer CMS status code (also known as CMS ERROR) received from cellular network. | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 63: Read Sms: Jsonrpc Method

    12. Read SMS: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems idfrom (optional parameter) minimal message-id...
  • Page 64 "UDH": "", "SMSCNumber": "+48790998250", "Class": "-1", "TextDecoded": "Test 2", "ID": "125", "RecipientID": "smseagle1", "Processed": "t", "id_folder": "1", "readed": "true", "oid": "5208facc-5912-4d21-8d31-7f830cf8f24e", "Status": "0" "UpdatedInDB": "2018-07-18 13:56:16", "ReceivingDateTime": "2018-07-17 15:05:49", "Text": "004C006F00720065006D00200069007000730075006D00200064006F006C006F0072002000 730069007400200061006D00650074002C00200063006F006E0073006500630074006500740 0750072002000610064006900700069007300630069006E006700200065006C00690074002E 002000430072006100730020006600650072006D0065006E00740075006D00200075006C006 C0061006D0063006F007200700065007200200065006700650073007400610073002E002000 | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 65 "Status": "DeliveryOK", "StatusError": "-1", "TPMR": "116", "RelativeValidity": "255", "CreatorID": "admin", "id_folder": "3", "StatusCode": "-1" "UpdatedInDB": "2018-07-13 11:40:45", "InsertIntoDB": "2018-07-13 11:40:40", "SendingDateTime": "2018-07-13 11:40:45", "DeliveryDateTime": null, "Text": "", "DestinationNumber": "*101#", "Coding": "8bit", "UDH": "", "SMSCNumber": "+48501200777", | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 66 "Class": "-1", "TextDecoded": "Test with unicode encoding: ąłóęźć", "ID": "576", "SenderID": "smseagle1", "SequencePosition": "1", "Status": "SendingOK", "StatusError": "-1", "TPMR": "86", "RelativeValidity": "255", "CreatorID": "admin", "id_folder": "3", "StatusCode": "-1" "UpdatedInDB": "2018-07-18 14:27:36", "InsertIntoDB": "2018-07-18 14:27:32", | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 67 "id_folder": "3", "StatusCode": "21" Response (when no data): {"result": "No data to display"} Response (when wrong logindata): {"result": "Invalid login or password"} Response (when wrong parameters): {"result": "Wrong parameters"} RESPONSE (EXTENDED): Sample response (inbox folder): | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 68 Praesent maximus luctus orci. Vestibulum lacus dui, vestibulum ac aliquam eget, ultrices et mi. In ac felis urna. Phasellus eget leo a leo congue ultricies. Donec tincidunt volutpat arcu a commodo", "ID": "126", | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 69 "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-9700-3G | User’s Manual...
  • Page 70 "StatusCode": "-1" "UpdatedInDB": "2018-07-18 14:27:36", "InsertIntoDB": "2018-07-18 14:27:32", "SendingDateTime": "2018-07-18 14:27:36", "DeliveryDateTime": null, "Text": "00540065007300740020006F006600200066006C0061007300680020006D00650073007300 6100670065", "DestinationNumber": "123456788", "Coding": "Default_No_Compression", "UDH": "", "SMSCNumber": "+48601000310", "Class": "0", "TextDecoded": "Test of flash message", "ID": "577", "SenderID": "smseagle1", | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 71 (software, user) updated the message content or state ReceivingDateTime timestamp when SMS was received Text text SMS text encoded using hex values SenderNumber character varying(30) SMS sender number Coding character varying(255) SMS text coding. Possible values: | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 72 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 73 RelativeValidity integer SMS relative validity (TP-VP) encoded as defined in GSM 03.40 CreatorID text username that created the SMS message id_folder integer identification of storage folder. Possible values: Sent items Trash 11… Custom folder | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 74: Delete Sms: Http Get Method

    13. Delete SMS: HTTP GET method HTTP GET METHOD https://url-of-smseagle/index.php/http_api/delete_sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems idfrom minimal id of message...

  • Page 75: Delete Sms: Jsonrpc Method

    </xml> 14. Delete SMS: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle folder one of the following: inbox, outbox, sentitems idfrom minimal id of message idto...

  • Page 76: Get Outgoing Queue Length: Http Get Method

    15. Get outgoing queue length: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/get_queue_length Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle responsetype (optional parameter) text = format response as text (default), xml = format response as XML object EXAMPLES: https://url-of-smseagle/index.php/http_api/get_queue_length?

  • Page 77: Get Outgoing Queue Length: Jsonrpc Method

    HTTP POST METHOD CALL: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle responsetype (optional parameter) simple = format response as simple object with one result field (default), extended = format response as extended JSON object BODY: {"method":"sms.get_queue_length", "params":{"login":"john","pass":"doe"}}...

  • Page 78: Get Inbox Length: Http Get Method

    17. Get inbox length: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/get_inbox_length Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle responsetype (optional parameter) text = format response as text (default), xml = format response as XML object EXAMPLES: https://url-of-smseagle/index.php/http_api/get_inbox_length?

  • Page 79: Get Inbox Length: Jsonrpc Method

    HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle responsetype (optional parameter) simple = format response as simple object with one result field (default), extended = format response as extended JSON object EXAMPLES: {"method":"sms.get_inbox_length", "params":{"login":"john","pass":"doe"}}...

  • Page 80: Get Sentitems Length: Http Get Method

    19. Get sentitems length: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/get_inbox_length Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle responsetype (optional parameter) text = format response as text (default), xml = format response as XML object EXAMPLES: https://url-of-smseagle/index.php/http_api/get_sentitems_length?

  • Page 81: Get Sentitems Length: Jsonrpc Method

    HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle responsetype (optional parameter) simple = format response as simple object with one result field (default), extended = format response as extended JSON object EXAMPLES: {"method":"sms.get_sentitems_length",...

  • Page 82: Get Gsm/3G Signal Strength: Http Get Method

    21. Get GSM/3G signal strength: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/get_gsmsignal Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in multimodem devices...

  • Page 83: Get Gsm/3G Signal Strength: Jsonrpc Method

    22. Get GSM/3G signal strength: JSONRPC method HTTP POST METHOD CALL: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in multimodem devices...

  • Page 84: Phonebook Group Create: Http Get Method

    23. Phonebook group create: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/group_create Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle groupname name for the created group public (optional parameter) 0 = private group, 1 = public group...

  • Page 85: Phonebook Group Create: Jsonrpc Method

    24. Phonebook group create: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle groupname name for the created group public (optional parameter) 0 = private group, 1 = public group...

  • Page 86: Phonebook Group Read: Http Get Method

    HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/group_read Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle public (optional parameter) 0 = private group (default value), 1 = public group (optional parameter) id of user who created the group...

  • Page 87: Phonebook Group Read: Jsonrpc Method

    HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle public (optional parameter) 0 = private group (default value), 1 = public group (optional parameter) id of user who created the group | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 88: Phonebook Group Update: Http Get Method

    Response (when wrong logindata): {"result": {"error_text":"Invalid login or password","status":"error"}} Response (when wrong parameters): {"result": {"error_text":"Wrong or missing >>uid<< parameter","status":"error"}} {"result": {"error_text":"Wrong or missing >>public<< parameter","status":"error"}} 27. Phonebook group update: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/group_update | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 89 Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle group_id id of existing group groupname name for the group public (optional parameter) 0 = private group, 1 = public group responsetype (optional parameter) text = format response as text (default), xml = format...

  • Page 90: Phonebook Group Update: Jsonrpc Method

    <status>error</status> </xml> 28. Phonebook group update: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle group_id id of existing group groupname name for the group public (optional parameter) 0 = private group, 1 = public group...

  • Page 91: Phonebook Group Delete: Http Get Method

    {"result": {"error_text":"Group with the given id does not exists","status":"error"}} 29. Phonebook group delete: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/group_delete Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle group_id id of existing group groupname name of existing group responsetype...

  • Page 92: Phonebook Group Delete: Jsonrpc Method

    <status>error</status> </xml> 30. Phonebook group delete: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle group_id id of existing group groupname name of existing group responsetype (optional parameter) simple = format response as simple object with one result...

  • Page 93: Phonebook Group Add Contact: Http Get Method

    31. Phonebook group add contact: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/group_addcontact Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact. The contact will be added to the group...

  • Page 94: Phonebook Group Add Contact: Jsonrpc Method

    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> 32. Phonebook group add contact: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 95 Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact. The contact will be added to the group responsetype (optional parameter) simple = format response as simple object with one result...

  • Page 96: Phonebook Group Remove Contact: Http Get Method

    33. Phonebook group remove contact: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/group_removecontact Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact. The contact will be removed from the group...

  • Page 97: Phonebook Group Remove Contact: Jsonrpc Method

    34. Phonebook group remove contact: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle group_id id of existing group (or id’s separated with comma) contact_id id of contact. The contact will be removed from the group...

  • Page 98: Phonebook Contact Create: Http Get Method

    35. Phonebook contact create: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/contact_create Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle contactname name for the created contact number telephone number for the created contact...

  • Page 99: Phonebook Contact Create: Jsonrpc Method

    <status>error</status> </xml> 36. Phonebook contact create: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle contactname name for the created contact | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 100: Phonebook Contact Read: Http Get Method

    37. Phonebook contact read: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/contact_read Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle public (optional parameter) 0 = private contacts (default value), 1 = public contacts | SMSEagle NXS-9700-3G...
  • Page 101 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-3G | User’s Manual...

  • Page 102: Phonebook Contact Read: Jsonrpc Method

    HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle public (optional parameter) 0 = private contacts (default value), 1 = public contacts (optional parameter) id of user who created the contact...
  • Page 103 Response (when no data): {"result": {"error_text":" No data to display","status":"error"}} Response (when wrong logindata): {"result": {"error_text":"Invalid login or password","status":"error"}} Response (when wrong parameters): {"result": {"error_text":"Wrong or missing >>uid<< parameter","status":"error"}} {"result": {"error_text":"Wrong or missing >>public<< parameter","status":"error"}} | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 104: Phonebook Contact Update: Http Get Method

    39. Phonebook contact update: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/contact_update Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle contact_id id of existing contact contactname name for the contact number phone number for the contact...

  • Page 105: Phonebook Contact Update: Jsonrpc Method

    <status>error</status> </xml> 40. Phonebook contact update: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle contact_id id of existing contact contactname name for the contact number phone number for the contact...

  • Page 106: Phonebook Contact Delete: Http Get Method

    {"result": {"error_text":"Contact with the given id does not exists","status":"error"}} 41. Phonebook contact delete: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/contact_delete Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact responsetype...

  • Page 107: Phonebook Contact Delete: Jsonrpc Method

    <error_text>Wrong or missing >>contact_id<< parameter</error_text> <status>error</status> </xml> Response (when contact_id is wrong): <xml> <error_text>Contact with the given id and name does not exists </error_text> <status>error</status> </xml> 42. Phonebook contact delete: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 108: Call With Termination: Http Get Method

    Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact responsetype (optional parameter) simple = format response as simple object with one result field (default), extended = format response as extended JSON object EXAMPLES: {"method":"phonebook.contact_delete",...
  • Page 109 Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle phone numer to call duration connection duration (in seconds) modem_no (optional parameter) modem number (only for multimodem devices) responsetype (optional parameter) text = format response as text (default), xml = format...

  • Page 110: Call With Termination: Jsonrpc Method

    44. Call with termination: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle phone numer to call duration connection duration (in seconds) modem_no (optional parameter) calling modem number (only for multimodem devices)

  • Page 111: Phonebook Shift Create: Http Get Method

    45. Phonebook shift create: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/shift_create Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle name name for the created shift enabled 0 = disabled, 1 = enabled...

  • Page 112: Phonebook Shift Create: Jsonrpc Method

    </xml> 46. Phonebook shift create: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle name name for the created shift enabled 0 = disabled, 1 = enabled...

  • Page 113: Phonebook Shift Read: Http Get Method

    47. Phonebook shift read: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/shift_read Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle name (optional parameter) shift name enabled (optional parameter) 0 = disabled, 1 = enabled...
  • Page 114 <thu_to/> <fri_from/> <fri_to/> <sat_from/> <sat_to/> <sun_from/> <sun_to/> <enabled>true</enabled> </shift> </shifts> <status>ok</status> </xml> Response (when no data): <xml> <error_text>No data to display</error_text> <status>error</status> </xml> Response (when wrong logindata): <xml> <error_text>Invalid login or password</error_text> <status>error</status> </xml> | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 115: Phonebook Shift Read: Jsonrpc Method

    48. Phonebook shift read: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle name (optional parameter) shift name enabled (optional parameter) 0 = disabled, 1 = enabled...
  • Page 116 "thu_from": null, "thu_to": null, "fri_from": null, "fri_to": null, "sat_from": null, "sat_to": null, "sun_from": null, "sun_to": null, "enabled": "false" "status": "ok" Response (when no data): {"result": {"error_text":" No data to display","status":"error"}} Response (when wrong logindata): | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 117: Phonebook Shift Update: Http Get Method

    {"result": {"error_text":" Wrong >> shift_id<< parameter ","status":"error"}} 49. Phonebook shift update: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/shift_update Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle shift_id id of existing shift name name for the shift enabled...

  • Page 118: Phonebook Shift Update: Jsonrpc Method

    <status>error</status> </xml> 50. Phonebook shift update: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle shift_id id of existing shift name name for the shift enabled 0 = disabled, 1 = enabled...

  • Page 119: Phonebook Shift Delete: Http Get Method

    51. Phonebook shift delete: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/shift_delete Parameter Description login your user to login to SMSEagle 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 120: Phonebook Shift Delete: Jsonrpc Method

    52. Phonebook shift delete: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle 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 121: Phonebook Shift Add Contact: Http Get Method

    53. Phonebook shift add contact: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/shift_addcontact Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) contact_id id of contact. The contact will be added to the shift...

  • Page 122: Phonebook Shift Add Contact: Jsonrpc Method

    Response (when id is wrong): <xml> <error_text>Shift with the given id does not exists</error_text> <status>error</status> </xml> <xml> <error_text>Contact with the given id does not exists</error_text> <status>error</status> </xml> 54. Phonebook shift add contact: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 123 Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) contact_id id of contact. The contact will be added to the shift responsetype (optional parameter) text = format response as text (default), xml = format...

  • Page 124: Phonebook Shift Remove Contact: Http Get Method

    55. Phonebook shift remove contact: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/shift_removecontact Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) contact_id id of contact. The contact will be added to the shift...

  • Page 125: Phonebook Shift Remove Contact: Jsonrpc Method

    56. Phonebook shift remove contact: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle shift_id id of existing shift (or id’s separated with comma) contact_id id of contact. The contact will be added to the shift...

  • Page 126: Get Modem State: Http Get Method

    57. Get modem state: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/get_modem_state Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in multimodem devices...

  • Page 127: Get Modem State: Jsonrpc Method

    58. Get modem state: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in multimodem devices | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 128: Set Modem State: Http Get Method

    59. Set modem state: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/set_modem_state Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle modem_no (optional parameter) modem number for status change (default = 1). Used only in multimodem devices...

  • Page 129: Set Modem State: Jsonrpc Method

    60. Set modem state: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle modem_no (optional parameter) modem number for status change (default = 1). Used only in multimodem devices...

  • Page 130: User Id Read: Http Get Method

    61. User ID read: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/userid_read Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle username username to be queried responsetype (optional parameter) text = format response as text (default), xml = format...

  • Page 131: User Id Read: Jsonrpc Method

    62. User ID read: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle username username to be queried responsetype (optional parameter) text = format response as text (default), xml = format...

  • Page 132: Group Members Read: Http Get Method

    63. Group members read: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/group_members_read Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle group_id ID of group to be queried user_id (optional parameter) show only contacts created by user with given ID...

  • Page 133: 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-3G | User’s Manual...
  • Page 134 HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle group_id ID of group to be queried user_id (optional parameter) show only contacts created by user with given ID public...
  • Page 135 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-9700-3G | User’s Manual...

  • Page 136: Plugins And Integration Manuals For Nms & Auth Systems

    SMSEagle has a number of ready-to-use plugins and integration manuals for an easy and quick integration of SMSEagle device with external software (Network Monitoring Systems, Authentication Systems and other). The list grows constantly and is published on SMSEagle website. For a complete and up to date list of plugins please go to: http://www.smseagle.eu/integration-plugins/...

  • Page 137: Extras

    EXTRAS Connecting directly to SMSEagle SQL database SMSEagle’s database operates on PostgreSQL database engine. 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...

  • Page 138: Injecting Long Sms Using Sql

    Ut enim ad minim veniam, qui', 'Default_No_Compression', 'smseagle1' 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.', | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 139 '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-9700-3G | User’s Manual...

  • Page 140: 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-3G | User’s Manual...

  • Page 141: 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 142 EXAMPLE OF READING GSM_NETNAME1 VALUE USING NET-SNMP LIBRARY a) Command for reading the result value: snmpget -v 2c -c public localhost .1.3.6.1.4.1.8072.1.3.2.3.1.2.12.71.83.77.95.78.101.116.78.97.109.101.49 Result: NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_NetName1" = STRING: PLAY Comment: Currently used network on SIM card is PLAY | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 143 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 144: 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 obsolete. To ease switch to SNMP v3 access control we’ve prepared special shell script located at /mnt/nand-user/smseagle directory.
  • Page 145 8. To enable v2 access policy run: ./snmpv3 enablev2 | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 146: Failover (Ha-Cluster) Feature

    (source: Wikipedia) SMSEagle NXS family has its own HA-cluster feature. For service to work you need at least 2 gateways ('aka' nodes). Our service monitors devices working in cluster and detects faults with following functions:...
  • Page 147 When the daemon running at MASTER device detects failure of at least one described features it immediately automatically switches cluster's IP assignment to the BACKUP device (node) providing continuous usage of the SMSEagle HA-cluster for the user. HOW TO CONFIGURE FAILOVER (HA-CLUSTER): Failover cluster can be easily configured using web-gui.
  • Page 148 Failover feature uses KEEPALIVED-MIB for SNMP monitoring. EXAMPLE OF READING DEVICE CLUSTER STATE VALUE USING NET-SNMP LIBRARY a) Command for reading the result value: snmpget -v 2c -c public ip-of-smseagle .1.3.6.1.4.1.9586.100.5.2.3.1.4.1 Result: KEEPALIVED-MIB::vrrpInstanceState.1 = INTEGER: master(2) Comment: Current device state is master | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 149: Forwarding Logs To External Server

    Forwarding all logs to external server (using UDP port) • At the bottom of the configuration file add: @server_ip_address:port @192.168.0.199:10514 • SSL-encryption of your log traffic: please have a look at this article: http://www.rsyslog.com/doc/v8-stable/tutorials/tls_cert_summary.html | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 150: 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-9700-3G...
  • Page 151 TROUBLESHOOTING | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 152: Troubleshooting

    SIM2 Not used Checking the device logs SMSEagle operates on Linux system. Linux system log is available under menu position “Settings” > “Sysinfo”. In case of any problems with the device this log is a valuable source of troubleshooting information.

  • Page 153: Restoring Factory Defaults

    3. Release SW button defaults. after 10 seconds. User LED will begin to Factory settings are being blink. applied to the device. 4. Wait until system System is going for a reboot. reboots. Default settings are restored. | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 154 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-3G | User’s Manual...
  • Page 155 SERVICE & REPAIR | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 156: Service & Repair

    60-650 Poznan, Poland WHEN CONTACTING SUPPORT TEAM, BE PREPARED TO PROVIDE THE FOLLOWING INFORMATION: System Information To get information about your SMSEagle, go to menu Settings > Maintenance. You will find there information about application and database version. System Logs Go to menu Settings >...
  • Page 157 TECH SPECS & SAFETY INFORMATION | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 158: Tech Specs & Safety Information

    Casing: ABS, DIN rail installation • Operating parameters: • Operating temperature: 10 ~ 60°C Humidity: 5 ~ 95% RH (no condensation) 3G Modem: • Waveband: GSM, UMTS GSM/GPRS quad-band 850/900/1800/1900 MHz UMTS 800/850/900/AWS 1700/1900/2100 MHz Output power (Rated): | SMSEagle NXS-9700-3G | User’s Manual...
  • Page 159 • 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 modem • modern responsive web interface • | SMSEagle NXS-9700-3G | User’s Manual...

  • Page 160: 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-3G | User’s Manual...

  • Page 161: 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 162: Disposal And Recycling Information

    Restriction of Hazardous Substances Directive (RoHS) European Union RoHS SMSEagle devices sold in the European Union, on or after 3 January 2013 meet the requirements of Directive 2011/65/EU on the restriction of the use of certain hazardous substances in electrical and electronic equipment (“RoHS recast”...
  • Page 163 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-3G | User’s Manual...

Table of Contents