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: 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 Compose SMS ............................... 16 Phonebook ................................17 Phonebook Contacts ............................17 Phonebook Groups ............................
Page 4 4. Send SMS to a group: JSONRPC method ....................48 5. Send SMS to contact: HTTP GET method ....................49 6. Send SMS to contact: JSONRPC method ....................51 7. Send USSD code: HTTP GET method ......................52 8. Send USSD code: JSONRPC method ......................53 9.
Page 5 34. Phonebook group remove contact: JSONRPC method ..............100 35. Phonebook contact create: HTTP GET method ................. 101 36. Phonebook contact create: JSONRPC method .................. 102 37. Phonebook contact read: HTTP GET method ..................103 38. Phonebook contact read: JSONRPC method ..................105 39.
Page 6 64. Group members read: JSONRPC method.................... 136 Plugins and integration manuals for NMS & Auth systems ..............138 Extras ..................................139 Connecting directly to SMSEagle database .................... 139 Injecting short SMS using SQL ........................139 Injecting long SMS using SQL ........................140 Database cleaning scripts ..........................
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 • 2x External omnidirectional 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 3G/4G antennas STEP 1: ANTENNA INSTALLATION GUIDELINES Install antennas 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 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-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
SMSEAGLE BASIC FEATURES Sending & Receiving SMS (managing messages with Inbox, Outbox, Sent Items) • Smartphone-like conversation mode (messages are nicely grouped by phone number). You can • easily track history of what you send and receive Sending to single numbers, contacts or groups from phonebook •...
Page 17: Phonebook
• Phonebook Web-GUI of SMSEagle device is equipped with Phonebook for managing contacts, groups and shifts. Each user can create private and public contacts, gather contacts in private and public groups. Contacts can also be optionally assigned to working shifts. Contacts and groups from Phonebook allows users efficient sending of messages.
Page 18: 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 19: 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 20: 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 21: 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 22 (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 23 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 24: 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 25 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: How do I configure Email2SMS plugin to accept FQDN email addresses for more details.
Page 26 ‘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 27: 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 28 Provide mailbox configuration (host, port, user, password, encryption settings) • If you want to delete emails from the mailbox after they are fetched by Email2SMS Poller, please • mark "Delete emails from server after processing" | SMSEagle NXS-9700-3G | User’s Manual...
Page 29: 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 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 • 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. | SMSEagle NXS-9700-3G...
Page 32: Sms Forward
Message header can be set to include original sender number or not to include. • Each rule is processed independently. • There is a possibility to enable/disable each rule. Screenshot form “Add/edit forwarding rule” | SMSEagle NXS-9700-3G | User’s Manual...
Page 33: Periodic Sms
Sending interval (Hourly, Daily, Weekly, Monthly or Annually) • Message type (SMS, USSD Code) • The content of the SMS text • The recipients (phone number(s) separated with comma or group(s) from phonebook) • | SMSEagle NXS-9700-3G | User’s Manual...
Page 34: Digital Input/Output
Screenshot from “Add new rule” window Digital input/output The NXS- family of SMSEagle devices is equipped with digital inputs (DI) and digital outputs (DO). The digital inputs can be used to receive signals from outside sensors or devices and automatically trigger sending of SMS message based on input state.
Page 35 PLUGIN CONFIGURATION The plugin “Digital input/output” allows you to define rules that control the behaviour of digital inputs/outputs on SMSEagle device. User may define several processing rules for both inputs and outputs. Screenshot from plugin window DIGITAL INPUTS For each processing rule for digital input user can define: The rule name •...
Page 36 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 37: 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 38 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 39 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 40: 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 41 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 42: 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 43: 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 44 <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 45: 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 46: Send Sms To A Group: Http Get 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 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 48: 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 49: 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 50 <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 contact doesn’t exist): <xml> <error_text>Invalid contact name – [contact_name]</error_text> <status>error</status> </xml> | SMSEagle NXS-9700-3G | User’s Manual...
Page 51: 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 52: 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 (url-encoded) modem_no (optional parameter) sending modem number (only for multimodem devices) responsetype...
Page 53: Send Ussd Code: Jsonrpc Method
</xml> Important notice: You must urlencode USSD code before sending it to gateway. Response from GSM/3G network will show up in device Inbox folder. 8. Send USSD code: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms | SMSEagle NXS-9700-3G | User’s Manual...
Page 54: Send Binary Sms: Http Get Method
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 (optional parameter) text = format response as text (default), xml = format...
Page 55 <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 or missing >>udh<< parameter </error_text> <status>error</status> | SMSEagle NXS-9700-3G | User’s Manual...
Page 56: 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 57: 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 58 Sample response (inbox folder): <xml> <messages> <item> <UpdatedInDB>2018-07-17 15:11:31</UpdatedInDB> <ReceivingDateTime>2018-07-17 15:04:04</ReceivingDateTime> <Text>005400650073007400200031</Text> <SenderNumber>+48123456789</SenderNumber> <Coding>Default_No_Compression</Coding> <UDH></UDH> <SMSCNumber>+48790998250</SMSCNumber> <Class>-1</Class> <TextDecoded>Test 1</TextDecoded> <ID>124</ID> <RecipientID>smseagle1</RecipientID> <Processed>t</Processed> <id_folder>1</id_folder> <readed>true</readed> <oid></oid> <Status>0</Status> </item> <item> <UpdatedInDB>2018-07-17 15:11:31</UpdatedInDB> <ReceivingDateTime>2018-07-17 15:04:10</ReceivingDateTime> <Text>005400650073007400200032</Text> <SenderNumber>+48123456788</SenderNumber> <Coding>Default_No_Compression</Coding> <UDH></UDH> | SMSEagle NXS-9700-3G | User’s Manual...
Page 59 Phasellus eget leo a leo congue ultricies. Donec tincidunt volutpat arcu a commodo</TextDecoded> <ID>126</ID> <RecipientID>smseagle1</RecipientID> <Processed>t</Processed> <id_folder>1</id_folder> <readed>true</readed> <oid></oid> <Status>0</Status> </item> </messages> <status>ok</status> </xml> Sample response (sentitems folder): <xml> <messages> <item> <UpdatedInDB>2018-06-07 11:29:56</UpdatedInDB> <InsertIntoDB>2018-06-07 11:29:43</InsertIntoDB> <SendingDateTime>2018-06-07 11:29:56</SendingDateTime> <DeliveryDateTime>2018-06-07 11:30:05</DeliveryDateTime> <Text>0074006500730074</Text> <DestinationNumber>123456789</DestinationNumber> <Coding>Default_No_Compression</Coding> <UDH></UDH> <SMSCNumber>+48501200777</SMSCNumber> <Class>-1</Class> | SMSEagle NXS-9700-3G | User’s Manual...
Page 60 <UpdatedInDB>2018-07-18 14:25:41</UpdatedInDB> <InsertIntoDB>2018-07-18 14:25:23</InsertIntoDB> <SendingDateTime>2018-07-18 14:25:28</SendingDateTime> <DeliveryDateTime>2018-07-18 14:25:28</DeliveryDateTime> <Text>0054006500730074002000740065007300740031</Text> <DestinationNumber>+48123456788</DestinationNumber> <Coding>Default_No_Compression</Coding> <UDH></UDH> <SMSCNumber>+48601000310</SMSCNumber> <Class>-1</Class> <TextDecoded>Test test1</TextDecoded> <ID>574</ID> <SenderID>smseagle1</SenderID> <SequencePosition>1</SequencePosition> <Status>DeliveryOK</Status> <StatusError>0</StatusError> <TPMR>84</TPMR> <RelativeValidity>255</RelativeValidity> <CreatorID>admin</CreatorID> <id_folder>3</id_folder> <StatusCode>-1</StatusCode> </item> <item> <UpdatedInDB>2018-07-18 14:27:13</UpdatedInDB> <InsertIntoDB>2018-07-18 14:27:03</InsertIntoDB> <SendingDateTime>2018-07-18 14:27:13</SendingDateTime> <DeliveryDateTime></DeliveryDateTime> | SMSEagle NXS-9700-3G | User’s Manual...
Page 61 <SequencePosition>1</SequencePosition> <Status>SendingOK</Status> <StatusError>-1</StatusError> <TPMR>87</TPMR> <RelativeValidity>255</RelativeValidity> <CreatorID>admin</CreatorID> <id_folder>3</id_folder> <StatusCode>-1</StatusCode> </item> <item> <UpdatedInDB>2018-07-18 14:29:29</UpdatedInDB> <InsertIntoDB>2018-07-18 14:28:46</InsertIntoDB> <SendingDateTime>2018-07-18 14:29:29</SendingDateTime> <DeliveryDateTime></DeliveryDateTime> <Text>0054006500730074002000770069007400680020006200610064002000700068006F0 06E00650020006E0075006D006200650072</Text> <DestinationNumber>11</DestinationNumber> <Coding>Default_No_Compression</Coding> <UDH></UDH> <SMSCNumber></SMSCNumber> <Class>-1</Class> <TextDecoded>Test with bad phone number</TextDecoded> <ID>578</ID> <SenderID>smseagle2</SenderID> <SequencePosition>1</SequencePosition> <Status>SendingError</Status> <StatusError>-1</StatusError> | SMSEagle NXS-9700-3G | User’s Manual...
Page 62 User Data Header encoded using hex values SMSCNumber character varying(20) SMSC number Class integer SMS class (0 is flash SMS, -1 is normal SMS, 127 is USSD) TextDecoded text decoded SMS text serial SMS unique identification number | SMSEagle NXS-9700-3G | User’s Manual...
Page 63 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 whether SMS was read in GUI or via API...
Page 64 11… Custom folder StatusCode integer CMS status code (also known as CMS ERROR) received from cellular network. - 1 No CMS Error > -1 CMS Error occurred. CMS error number is saved in this field. | SMSEagle NXS-9700-3G | User’s Manual...
Page 65: 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 idto (optional parameter) maximum message-id...
Page 66 "SMSCNumber": "+48790998250", "Class": "-1", "TextDecoded": "Test 2", "ID": "125", "RecipientID": "smseagle1", "Processed": "t", "id_folder": "1", "readed": "true", "oid": "5208facc-5912-4d21-8d31-7f830cf8f24e", "Status": "0" "UpdatedInDB": "2018-07-18 13:56:16", "ReceivingDateTime": "2018-07-17 15:05:49", "Text": "004C006F00720065006D00200069007000730075006D00200064006F006C006F0072002000 730069007400200061006D00650074002C00200063006F006E0073006500630074006500740 0750072002000610064006900700069007300630069006E006700200065006C00690074002E 002000430072006100730020006600650072006D0065006E00740075006D00200075006C006 C0061006D0063006F007200700065007200200065006700650073007400610073002E002000 4E0075006C006C006100200070006C006100630065007200610074002000660069006E00690 | SMSEagle NXS-9700-3G | User’s Manual...
Page 67 "SMSCNumber": "+48501200777", "Class": "-1", "TextDecoded": "test", "ID": "456", "SenderID": "smseagle1", "SequencePosition": "1", "Status": "DeliveryOK", "StatusError": "-1", "TPMR": "116", "RelativeValidity": "255", "CreatorID": "admin", "id_folder": "3", "StatusCode": "-1" "UpdatedInDB": "2018-07-13 11:40:45", "InsertIntoDB": "2018-07-13 11:40:40", "SendingDateTime": "2018-07-13 11:40:45", | SMSEagle NXS-9700-3G | User’s Manual...
Page 68 "id_folder": "3", "StatusCode": "-1" "UpdatedInDB": "2018-07-18 14:27:13", "InsertIntoDB": "2018-07-18 14:27:03", "SendingDateTime": "2018-07-18 14:27:13", "DeliveryDateTime": null, "Text": "00540065007300740020007700690074006800200075006E00690063006F00640065002000 65006E0063006F00640069006E0067003A00200105014200F30119017A0107", "DestinationNumber": "123456788", "Coding": "Unicode_No_Compression", "UDH": "", "SMSCNumber": "+48601000310", "Class": "-1", "TextDecoded": "Test with unicode encoding: ąłóęźć", | SMSEagle NXS-9700-3G | User’s Manual...
Page 69 "SendingDateTime": "2018-07-18 14:29:29", "DeliveryDateTime": null, "Text": "0054006500730074002000770069007400680020006200610064002000700068006F006E00 650020006E0075006D006200650072", "DestinationNumber": "11", "Coding": "Default_No_Compression", "UDH": "", "SMSCNumber": "", "Class": "-1", "TextDecoded": "Test with bad phone number", "ID": "578", "SenderID": "smseagle1", "SequencePosition": "1", "Status": "SendingError", "StatusError": "-1", "TPMR": "-1", | SMSEagle NXS-9700-3G | User’s Manual...
Page 70 "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", "ID": "125", "RecipientID": "smseagle1", "Processed": "t", "id_folder": "1", "readed": "true", "oid": "5208facc-5912-4d21-8d31-7f830cf8f24e", | SMSEagle NXS-9700-3G | User’s Manual...
Page 71 "Status": "0" "status": "ok" Sample response (sentitems folder): "result": { "messages": [ "UpdatedInDB": "2018-06-07 11:29:56", "InsertIntoDB": "2018-06-07 11:29:43", "SendingDateTime": "2018-06-07 11:29:56", "DeliveryDateTime": "2018-06-07 11:30:05", "Text": "0074006500730074", "DestinationNumber": "+48123456789", "Coding": "Default_No_Compression", "UDH": "", "SMSCNumber": "+48501200777", | SMSEagle NXS-9700-3G | User’s Manual...
Page 72 "DeliveryDateTime": "2018-07-18 14:25:28", "Text": "0054006500730074002000740065007300740031", "DestinationNumber": "+48123456788", "Coding": "Default_No_Compression", "UDH": "", "SMSCNumber": "+48601000310", "Class": "-1", "TextDecoded": "Test test1", "ID": "574", "SenderID": "smseagle1", "SequencePosition": "1", "Status": "DeliveryOK", "StatusError": "0", "TPMR": "84", "RelativeValidity": "255", "CreatorID": "admin", | SMSEagle NXS-9700-3G | User’s Manual...
Page 73 "SMSCNumber": "+48601000310", "Class": "0", "TextDecoded": "Test of flash message", "ID": "577", "SenderID": "smseagle1", "SequencePosition": "1", "Status": "SendingOK", "StatusError": "-1", "TPMR": "87", "RelativeValidity": "255", "CreatorID": "admin", "id_folder": "3", "StatusCode": "-1" "UpdatedInDB": "2018-07-18 14:29:29", "InsertIntoDB": "2018-07-18 14:28:46", | SMSEagle NXS-9700-3G | User’s Manual...
Page 74 SMS text encoded using hex values SenderNumber character varying(30) SMS sender number Coding character varying(255) SMS text coding. Possible values: ‘Default_No_Compression’, ‘Unicode_No_Compression’, ‘8bit’, ‘Default_Compression’, ‘Unicode_Compression’ text User Data Header encoded using hex values SMSCNumber character varying(20) SMSC number | SMSEagle NXS-9700-3G | User’s Manual...
Page 75 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 76 11… Custom folder StatusCode integer CMS status code (also known as CMS ERROR) received from cellular network. - 1 No CMS Error > -1 CMS Error occurred. CMS error number is saved in this field. | SMSEagle NXS-9700-3G | User’s Manual...
Page 77: 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 idto...
Page 78: 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 79: 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 80: 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 81: 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 82: 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 83: 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 84: 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 85 SMSEagle modem_no (optional parameter) modem number to be queried (default = 1). Used only in multimodem devices responsetype (optional parameter) text = format response as text (default), xml = format response as XML object EXAMPLES: https://url-of-smseagle/index.php/http_api/get_gsmsignal?
Page 86: 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 87: Phonebook Group Create: Jsonrpc Method
<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 or missing >>groupname<< parameter</error_text> <status>error</status> </xml> 24. Phonebook group create: JSONRPC method HTTP POST METHOD: | SMSEagle NXS-9700-3G | User’s Manual...
Page 88: Phonebook Group Read: Http Get Method
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 responsetype (optional parameter) simple = format response as simple object with one result...
Page 89 Sample response: <xml> <groups> <item> <Name>private</Name> <ID>2</ID> <id_user>2</id_user> <is_public>true</is_public> </item> <item> <Name>Everyone</Name> <ID>3</ID> <id_user>1</id_user> <is_public>true</is_public> </item> <item> <Name>work</Name> <ID>4</ID> <id_user>1</id_user> <is_public>true</is_public> </item></groups> <status>ok</status> </xml> Response (when no data): <xml> <error_text>No data to display</error_text> <status>error</status> | SMSEagle NXS-9700-3G | User’s Manual...
Page 90: 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...
Page 91: Phonebook Group Update: Http Get Method
{"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 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...
Page 92: Phonebook Group Update: Jsonrpc Method
<error_text>Wrong or missing >>group_id<< parameter</error_text> <status>error</status> </xml> Response (when group_id is wrong): <xml> <error_text>Group with the given id does not exists</error_text> <status>error</status> </xml> 28. Phonebook group update: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description | SMSEagle NXS-9700-3G | User’s Manual...
Page 93: Phonebook Group Delete: Http Get Method
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) simple = format response as simple object with one result...
Page 94 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) text = format response as text (default), xml = format response as XML object EXAMPLES: https://url-of-smseagle/index.php/http_api/group_delete?
Page 95: 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 96: 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 97: Phonebook Group Add Contact: Jsonrpc Method
32. Phonebook group add 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 added to the group...
Page 98: 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 99 <error_text>Wrong or missing >>contact_id<< parameter</error_text> <status>error</status> </xml> Response (when id is wrong): <xml> <error_text>Group with the given id does not exists</error_text> <status>error</status> </xml> <xml> <error_text>Contact with the given id does not exists</error_text> <status>error</status> </xml> | SMSEagle NXS-9700-3G | User’s Manual...
Page 100: 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 101: 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 102: Phonebook Contact Create: Jsonrpc Method
</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 number telephone number for the created contact...
Page 103: 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 (optional parameter) id of user who created the contact...
Page 104 <Name>Andy</Name> <Number>+441234155931</Number> <id_user>1</id_user> <is_public>true</is_public> </item> </contacts> <status>ok</status> </xml> Response (when no data): <xml> <error_text>No data to display</error_text> <status>error</status> </xml> Response (when wrong logindata): <xml> <error_text>Invalid login or password</error_text> <status>error</status> </xml> Response (when wrong parameters): | SMSEagle NXS-9700-3G | User’s Manual...
Page 105: 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 106: Phonebook Contact Update: Http Get Method
{"result": {"error_text":"Wrong or missing >>public<< parameter","status":"error"}} 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...
Page 107 <error_text>Wrong or missing >>contactname<< parameter</error_text> <status>error</status> </xml> <xml> <error_text>Wrong or missing >>contact_id<< parameter</error_text> <status>error</status> </xml> <xml> <error_text>Wrong or missing >>number<< parameter</error_text> <status>error</status> </xml> Response (when contact_id is wrong): <xml> <error_text>Contact with the given id does not exists</error_text> | SMSEagle NXS-9700-3G | User’s Manual...
Page 108: 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 109: 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 110: Phonebook Contact Delete: Jsonrpc Method
<status>error</status> </xml> 42. Phonebook contact 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 contact_id id of existing contact contactname name of existing contact responsetype (optional parameter) simple = format response as simple object with one result...
Page 111: Call With Termination: Http Get Method
43. Call with termination: HTTP GET method HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/call_with_termination 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 112: Call With Termination: Jsonrpc Method
Response (when modem_no is wrong): <xml> <error_text> Modem not recognized </error_text> <status>error</status> </xml> Important notice: this method is available only for devices with 3G voice modem 44. Call with termination: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms | SMSEagle NXS-9700-3G | User’s Manual...
Page 113 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) responsetype (optional parameter) text = format response as text (default), xml = format...
Page 114: 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 115: 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 116: 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 117: Phonebook Shift Read: Jsonrpc Method
Response (when wrong parameters): <xml> <error_text> Wrong >>id<< parameter</error_text> <status>error</status> </xml> Response (when wrong parameters): <xml> <error_text> Wrong >>enabled<< parameter</error_text> <status>error</status> </xml> 48. Phonebook shift read: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description | SMSEagle NXS-9700-3G | User’s Manual...
Page 118 SMSEagle pass your password to login to SMSEagle name (optional parameter) shift name enabled (optional parameter) 0 = disabled, 1 = enabled shift_id (optional parameter) shift id responsetype (optional parameter) text = format response as text (default), xml = format...
Page 119: 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 120 Response (when wrong parameters): <xml> <error_text>Wrong or missing >>name<< parameter</error_text> <status>error</status> </xml> <xml> <error_text>Wrong or missing >>shift_id<< parameter</error_text> <status>error</status> </xml> Response (when shift_id is wrong): <xml> <error_text>Shift with given id does not exists</error_text> <status>error</status> </xml> | SMSEagle NXS-9700-3G | User’s Manual...
Page 121: Phonebook Shift Update: Jsonrpc Method
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 122: 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 123: 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 124: 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 125: Phonebook Shift Add Contact: Jsonrpc Method
54. Phonebook shift add 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: 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 127: Phonebook Shift Remove Contact: Jsonrpc Method
<error_text>Shift with the given id does not exists</error_text> <status>error</status> </xml> <xml> <error_text>Contact with the given id does not exists</error_text> <status>error</status> </xml> 56. Phonebook shift remove contact: JSONRPC method HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms Parameter Description | SMSEagle NXS-9700-3G | User’s Manual...
Page 128: Get Modem State: Http Get Method
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 129 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 responsetype (optional parameter) text = format response as text (default), xml = format...
Page 130: 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...
Page 131: 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 132: 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 133: 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 134: 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 135: 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 136: Group Members Read: Jsonrpc Method
64. Group members 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 group_id ID of group to be queried user_id (optional parameter) show only contacts created by user with given ID...
Page 137 {"result": {"error_text":"Invalid login or password","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-9700-3G | User’s Manual...
Page 138: 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 139: Extras
EXTRAS Connecting directly to SMSEagle 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 140: 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 141 '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 142: 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 143: 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 144 NET-SNMP-EXTEND-MIB::nsExtendOutputFull."GSM_Signal" = STRING: 54 Comment: GSM/3G Signal strength value is 54% 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: | SMSEagle NXS-9700-3G | User’s Manual...
Page 145 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 146: 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 147 7. To disable v2 access policy run: ./snmpv3 disablev2 8. To enable v2 access policy run: ./snmpv3 enablev2 | SMSEagle NXS-9700-3G | User’s Manual...
Page 148: 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 149 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 150 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 151: 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 152: 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 153 TROUBLESHOOTING | SMSEagle NXS-9700-3G | User’s Manual...
Page 154: Troubleshooting
Slow flashing in stand-by mode, Quick flashing when modem 2 in use 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 155: 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 156 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 157 SERVICE & REPAIR | SMSEagle NXS-9700-3G | User’s Manual...
Page 158: 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 159 TECH SPECS & SAFETY INFORMATION | SMSEagle NXS-9700-3G | User’s Manual...
Page 160: 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-9700-3G | User’s Manual...
Page 161 EDGE 900: Class E2, EDGE 1800: Class E2 ▪ FDD I: Class 3, FDD VIII: Class 3 ▪ Device type NXS-9750-4G: Waveband: UMTS, LTE LTE Bands: LTE FDD: 1-5, 7, 8, 12, 13, 17, 20, 25, 26, 28, 29, 30 (Rx only), 66...
Page 162 Omnidirectional 3dBi antenna with magnetic foot Waveband: GSM,UMTS Cable length 3m Device type NXS-9750-4G: • Omnidirectional 2dBi antenna with magnetic foot Waveband: GSM,UMTS, LTE Cable length 3m SENDING/RECEIVING THROUGHPUT Incoming transmission rate: up to 60 SMS/min • Outgoing transmission rate: up to 60 SMS/min •...
Page 163: 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 164: 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 165: Canadian Regulatory Statement
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 166 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...

This manual is also suitable for:

Nxs-9750-3g Nxs-9700-4g Nxs-9700-3g Mhd-8100-3g Mhd-8100-4g

SMSEagle NXS-9750-4G User Manual

Quick Links

Need help?

Questions and answers

Related Manuals for SMSEagle NXS-9750-4G

Summary of Contents for SMSEagle NXS-9750-4G

This manual is also suitable for:

Table of Contents