SMSEagle NXS-9700-3G User Manual Download Page 2

Page: 2 / 229

Congratulations

on purchasing

SMSEAGLE

The materials used in this publication are copyright and are

not to be duplicated, copied, or used without the prior consent

of the copyright holder. Technical specifications and information in

this document are subject to change without prior notice being given.

Document version: 4.32

Summary of Contents for NXS-9700-3G

Page 1: ...Rev 1 Rev 2 Rev 3 Rev 4 User s Manual SMSEAGLE NXS 9700 3G NXS 9700 4G...

Page 2: ...this publication are copyright and are not to be duplicated copied or used without the prior consent of the copyright holder Technical specifications and information in this document are subject to c...

Page 3: ...and using placeholders 25 Folders 26 MMS 27 Purge folders automatic message cleanup 28 Phonebook 29 Phonebook Contacts 29 Phonebook Groups 30 Phonebook Escalation Groups 31 Phonebook Working Shifts 3...

Page 4: ...URL plugin 67 Periodic SMS 69 Autoreply plugin 70 Digital input output 71 Temperature humidity sensors 77 LDAP plugin 80 Blacklist 82 SMSEagle API 84 0 API Authentication 84 1 Send SMS HTTP GET method...

Page 5: ...hod 134 23 Phonebook group create HTTP GET method 135 24 Phonebook group create JSONRPC method 136 25 Phonebook group read HTTP GET method 137 26 Phonebook group read JSONRPC method 139 27 Phonebook g...

Page 6: ...ook shift delete HTTP GET method 174 52 Phonebook shift delete JSONRPC method 175 53 Phonebook shift add contact HTTP GET method 176 54 Phonebook shift add contact JSONRPC method 178 55 Phonebook shif...

Page 7: ...SQL 201 Injecting long SMS using SQL 202 Database cleaning scripts 204 SNMP agent 205 Setting up SNMP v3 access control 208 Forwarding logs to external server 210 Automatic software updates check 211...

Page 8: ...26 Avis de conformit la r glementation d Industrie Canada 226 UK Declaration of Conformity 226 RF Exposure Limits 226 Disposal and Recycling Information 227 Information gem 4 Absatz 4 Elektrogesetz DE...

Page 9: ...9 SMSEagle NXS 9700 3G User s Manual GET READY TO START I...

Page 10: ...T AGREE TO BE BOUND BY THE TERMS OF THIS EULA DO NOT USE THE SMSEAGLE DEVICE AND YOU MAY CHOOSE TO PROMPTLY RETURN THE DEVICE FOR A REFUND OF ITS PURCHASE PRICE BY CONTACTING PROXIMUS AT THE ADDRESS A...

Page 11: ...nactment and includes any statute statutory provision or subordinate legislation which it amends or re enacts provided that as between the Parties no such amendment or re enactment shall apply for the...

Page 12: ...e Software other than what may be used within Your SMSEagle device in accordance with this License d Reverse engineer decompile or disassemble the SMSEagle Software nor attempt to locate or obtain its...

Page 13: ...SHALL COVER THE TOTAL FOR ALL SUCH INCIDENTS AND CLAIMS THE AFOREMENTIONED LIMITATIONS EXCLUSIONS AND ANY DISCLAIMERS SHALL APPLY TO THE MAXIMUM EXTENT ALLOWABLE BY LAW EVEN SHOULD ANY PROPOSED REMEDY...

Page 14: ...ns of Polish Copyright Act 4th February 1994 Journal of Laws 1994 No 24 item 83 This Agreement shall be governed in all respects by the laws of the Republic of Poland 9 06 DISPUTE RESOLUTION All dispu...

Page 15: ...lude this EULA not connected directly with its business or professional activity or in case of entrepreneur being a natural person not connected directly with its professional activity applied to the...

Page 16: ...le NXS 9700 User s Manual WHAT S IN THE BOX Your SMSEagle box contains SMSEagle hardware SMS gateway External omnidirectional antenna with magnetic foot AC DC power supply input voltage 100 240V Warra...

Page 17: ...n conjunction with any other antenna or transmitter The antenna must not be installed inside metal cases Plug in antenna connector to the device Please install SIM Card when the device is SWITCHED OFF...

Page 18: ...yboard to USB port note cables are not provided login to the terminal window using root credentials these were provided with your device edit configuration file with command nano mnt nand user smseagl...

Page 19: ...the IP address assigned to your gateway SMSEAGLE DEFAULT USER Login to application with above username and password D CONFIGURE STATIC IP SETTINGS IN WEB GUI OPTIONAL Click on menu position Settings...

Page 20: ...rtificate SMSEagle device comes with a self signed SSL certificate Follow the instructions in the chapter SSL Certificate and HTTPS Redirection if you want to install your own SSL certificate or a fre...

Page 21: ...21 SMSEagle NXS 9700 User s Manual USING OF SMSEAGLE II...

Page 22: ...ial port 2x GND SIM Card Slot SIM1 SIM2 optional SIM card slot s HDMI port HDMI HDMI port for debugging purposes only USB port USB USB port for debugging purposes only Ethernet Port ETH Ethernet RJ45...

Page 23: ...phones 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 P...

Page 24: ...between selected hours Message templates save edit your own templates Unicode support support of national characters Multiuser support each user has access to a private Inbox Outbox Sent Items Compos...

Page 25: ...Eagle software allows you to import SMS text from CSV file and optionally use special placeholders in a message body Placeholders are special fields which are replaced with unique values for each mess...

Page 26: ...ders contain your messages They are conveniently grouped into 6 categories Inbox Outbox Sent Items Spam Trash The view of conversations can be either of type Balloons smartphone like conversation or T...

Page 27: ...27 SMSEagle NXS 9700 User s Manual Table view type MMS To view an MMS attachment you need to click show MMS attachment in the inbox message...

Page 28: ...p messages logs in selected folders Screenshot with example from Purge folders screen Screenshot from Add or edit purging rule In adding or editing a cleanup rule you can set Rule name Purging interva...

Page 29: ...shifts Contacts and groups from Phonebook allows users efficient sending of messages Phonebook Contacts Below we present a main Phonebook view where user manages his Contacts Screenshot of default ph...

Page 30: ...Add contact to a Group Add contact to a Working Shift Enable disable Vacation mode messages are not sent when Vacation mode is enabled Phonebook Groups Screenshot taken from phonebook groups In Phone...

Page 31: ...single user the owner Phonebook Escalation Groups Escalation group is a special version of a Phonebook group When a group is set as an Escallation group a single message sent to the group will be esca...

Page 32: ...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 Users The Users function allows...

Page 33: ...or public shared Phonebook contacts and groups see details in Phonebook chapter Users with User role has its own private sent items folder they cannot see messages sent by other users Users with Admi...

Page 34: ...le 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...

Page 35: ...in User Settings menu MFA tab Screenshot from User Settings MFA After pressing MFA Enable button verification code is sent via SMS text to the number specified in Personal data tab The code must be en...

Page 36: ...y code can be used The recovery code can be found in User Settings MFA tab Remember to save the single use recovery code in a safe place Recovery code is recreated after use Screenshot from User Setti...

Page 37: ...9700 User s Manual Screenshot from Edit Add User Settings Settings menu is divided into several tabs for easier maintenance Application Settings Application settings can be changed under the Settings...

Page 38: ...h first You can set the receiving of delivery reports to Yes No or Default network carrier setting You can set the visibility of the Inbox content to All users or Only admins You can set access of the...

Page 39: ...You can set the Gateway IP Address You can set DNS 1 You can optionally set DNS 2 You can view the MAC address of your device You can input Hostname You can choose to Use proxy Failover Failover conf...

Page 40: ...ou can set automatic time synchronization with NTP timeserver disable automatic time synchronization or create NTP server on SMSEagled device date time will be obtained from 3G 4G network You can set...

Page 41: ...allows to enable 2G network connectivity 2G is disabled by default and should be only enabled for devices located in areas where there are connectivity problems with 4G 3G cellular networks Email Aler...

Page 42: ...You can set the email s of recipients You can set the email subject and content of the message including placeholders You can enter your SMTP server settings for sending emails You can save debug info...

Page 43: ...Notice This feature is available only devices with 3G modems Call forward settings can be accessed under the Settings tab Call forward You can choose to forward all incoming calls to a chosen number M...

Page 44: ...rd operator Data Connection Data connection settings can be accessed under the Settings tab Data conn Here you can control a mobile data connection on your device It can be used for example to utilize...

Page 45: ...ivate key in PEM format The certificate cannot be password protected Notice If you want to use Let s encrypt certificate please follow this guide in our knowledgebase Root CA Full chain optional If yo...

Page 46: ...ypt transmitted information Private key CSR file private key decryption key must be kept for exclusive information of the certificate owner This file should be uploaded together with SSL certificate B...

Page 47: ...menu Settings Updates tab SMSEagle software is under process of continual improvement We listen to our customers and new releases are based on our customer s inputs requests Software updates are relea...

Page 48: ...update EXPIRING TECHNICAL SUPPORT NOTIFICATION Similar to automatic software update checks mechanism for technical support validity provides information about the technical support expiry date A month...

Page 49: ...49 SMSEagle NXS 9700 User s Manual Notice Your SMSEagle device must have a HTTPS connectivity with the address updates smseagle eu in order for this feature to work...

Page 50: ...stem or whole node without requiring administrative intervention a process known as failover source Wikipedia SMSEagle NXS family devices have their own failover mechanism based on HA cluster This fea...

Page 51: ...there is no need for any network configuration If two nodes are behind firewalls make sure firewall is configured to accept multicast and VRRP protocol IP Protocol 112 HOW TO CONFIGURE FAILOVER HA CLU...

Page 52: ...his feature is only available in devices with hardware Rev 2 and higher After correct configuration of the HA cluster you should access the cluster via its Virtual IP address SNMP monitoring of HA clu...

Page 53: ...device or service that operates ICMP TCP UDP or SNMP protocol SMSEagle Network Monitoring plugin sequentially controls availability of defined hosts services in Network Monitoring feature and sends de...

Page 54: ...e will check if port is open or SNMP to monitor objects via SNMP protocol supported return types numeric string increase a default timeout value for busy servers by default we set it to 30 seconds tes...

Page 55: ...message received in case of no response from server service TIMESTAMP timestamp of an error Receive SMS alerts be alerted when your services servers go down or go up after failure give yourself a cha...

Page 56: ...of your device REPORTS This tab allows you to view reports of task errors in the Network Monitor for a selected period of time Screenshot from Network Monitor Reports window SNMP TRAPS SNMP trap is a...

Page 57: ...ddress PHONE_NUMBER IP_ADDRESS_OF_SMSEAGLE will be converted to SMS message Where PHONE_NUMBER is a destination phone number IP_ADDRESS_OF_SMSEAGLE is the IP address of your device The text of the ema...

Page 58: ...168 0 101 will be converted to SMS message and delivered to all members of myldap admins1 group The myldap admins1 group must be defined in your LDAP directory and LDAP plugin must be configured on yo...

Page 59: ...ent on 2018 01 01 00 05 via modem number 2 PLUGIN CONFIGURATION Plugin Email To SMS allows to add many forwarding rules Each rule can be enabled or disabled by user Screenshot from Email To SMS Rules...

Page 60: ...email in SMS message set What to do with email subject setting to Send only subject without email body Only the email subject will be inserted in the SMS message the text of an email will be cropped t...

Page 61: ...agle mycompany com FROM john doe mycompany com SUBJECT 48333444555 BODY Hello world In this case SMSEagle gateway will fetch an incoming email from smseagle mycompany com account and send its body as...

Page 62: ...62 SMSEagle NXS 9700 User s Manual Screenshot from Email to SMS Poller Add new rule You can name your rule You can set forwarding to Always or For specified senders when email contains...

Page 63: ...ude special national characters enable Unicode encoding of SMS text Choose protocol from IMAP or POP3 Provide mailbox configuration host port user password encryption settings If you want to delete em...

Page 64: ...last sender If no last sender is found then the incoming message is forwarded to a default email address given in plugin settings b It forwards all the incoming messages to one fixed email address In...

Page 65: ...Email settings enter SMTP configuration for your SMTP server that will be used for sending emails EMAIL TEXT FROM PLUGIN Email body from SMS To Email plugin contains phone number from incoming SMS and...

Page 66: ...ndow For each rule user can define When incoming SMS should be forwarded Rule type and to what number s the message should be forwarded SMS Recipient Whether or not include in SMS a sender number from...

Page 67: ...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 P...

Page 68: ...the request is always sent sent only when SMS sender belongs to a given contact group or only when incoming message contains a given character string Optionally you can define API key of your service...

Page 69: ...d independently PLUGIN CONFIGURATION Plugin Periodic SMS allows to add many sending rules Each rule can be enabled or disabled by user Screenshot from main plugin window For each rule the user can def...

Page 70: ...ws to automatically respond to each received message with defined text response PLUGIN CONFIGURATION Plugin Autoreply allows to add many autoreply rules Each rule can be enabled or disabled by user Sc...

Page 71: ...tes phone number Screenshot form Add edit autoreply rule Digital input output The NXS family of SMSEagle devices is equipped with digital inputs DI and digital outputs DO The digital inputs can be use...

Page 72: ...use digital output with relay it is recommended to connect a separate protection diode a k a snubber across the relay coil terminals as well A diode snubber circuit can be added when ordering from so...

Page 73: ...ing inputs should be tied to a logic 1 or logic 0 as appropriate for the circuit We do this by using what are commonly called Pull up Resistors to give the input pin a defined default state if there i...

Page 74: ...s 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 Digital Input connection example with...

Page 75: ...name Port number State of input signal that will trigger sending of SMS message field When input signal SMS text field Send SMS message The recipient s name from phonebook Alert timeout This value def...

Page 76: ...he rule name Port number On what condition digital output should be set all incoming messages when incoming SMS comes from specified contact in phonebook or when incoming SMS text contains given value...

Page 77: ...internal temperature and humidity sensor The internal sensor allows to measure temperature with 0 5 C accuracy and humidity with 2 RH accuracy Additionally NXS 97xx Rev 3 and higher devices also supp...

Page 78: ...alarms for temperature and humidity User may define several processing rules Screenshot from Alarms window For each processing rule for digital output user can define The rule name Sensor internal or...

Page 79: ...er may enable disable sensor and set sensor reading period in minutes If external sensors are supported they can be added and defined here Screenshot from Settings window READING TEMP HUMIDITY VIA SNM...

Page 80: ...Multiple sensors are supported and can be attached in parallel Once attached to the device you need to Scan for sensors in Temp Sensors Settings menu LDAP plugin The LDAP plugin allows to access Acti...

Page 81: ...connected with AD server Screenshot showing successful connection to AD server With connection established AD contacts groups suggestions are shown in selected modules of web gui Start typing any part...

Page 82: ...ns can be used in Compose Autoreply and Digital input output modules Blacklist This feature allows you to add a number to a Blacklist When a number is on this list the device automatically blocks any...

Page 83: ...NXS 9700 User s Manual Screenshot from Blacklist Define STOP word feature You may defined a STOP keyword When incoming message contains the keyword then the sender number will be automatically added t...

Page 84: ...n be either access_token recommended solution Edit your API User check Enable token and generate new access token The token will be used to authenticate in API methods or b login and password Use your...

Page 85: ...igned to incoming message only if incoming phone number matches exactly the phone number including country code from outgoing message modem_no optional parameter sending modem number only for multimod...

Page 86: ...SPONSE 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_te...

Page 87: ...r defined unique ID that is assigned to a message recipient pair The oid is a varchar 36 that uniquely identifies a message sent to a particular recipient particular phone number The value of this ID...

Page 88: ...od sms send_sms params access_token 0005gOjCOlMH8F2x to 481234567 message My message or method sms send_sms params access_token 0005gOjCOlMH8F2x to 481234567 message My message date 201401152132 or me...

Page 89: ...n format YYYYmmDDHHMM YYYY year mm month DD day HH hour MM minute If this parameter is not null SMS will be scheduled for sending at the given date and time highpriority optional parameter 0 normal pr...

Page 90: ...cess_token 0005gOjCOlMH8F2x groupname admins message mymessage date 20140 1152132 https url of smseagle http_api send_togroup access_token 0005gOjCOlMH8F2x groupname admins message mymessage highprior...

Page 91: ...month DD day HH hour MM minute If this parameter is not null SMS will be scheduled for sending at the given date and time highpriority optional parameter 0 normal priority 1 SMS will have higher prior...

Page 92: ...eter 1 simulate message sending Messages with that parameter will not be added to outbox and they will return ID 0 EXAMPLES method sms send_togroup params access_token 0005gOjCOlMH8F2x groupname admin...

Page 93: ...ear mm month DD day HH hour MM minute If this parameter is not null SMS will be scheduled for sending at the given date and time highpriority optional parameter 0 normal priority 1 SMS will have highe...

Page 94: ...ctname johndoe message mymessage date 20 1401152132 https url of smseagle http_api send_tocontact access_token 0005gOjCOlMH8F2x contactname johndoe message mymessage highpri ority 1 RESPONSE Response...

Page 95: ...ils in point API Authentication pass your password to login to SMSEagle contactname contact name defined in your SMSEagle Phonebook The contact must be defined as Public message your SMS message date...

Page 96: ...l parameter this parameter is only used when parameter message_type mms The parameter accepts array with MMS attachments Each array element must contain content type mime type of attached file Support...

Page 97: ...oken status error Response when contact doesn t exist result error_text Invalid contact name contact_name status error Response when wrong parameters result error_text Wrong parameters status error 7...

Page 98: ...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 e...

Page 99: ...params access_token 0005gOjCOlMH8F2x to 101 RESPONSE Response result OK ID ID of message in outbox Sample response result OK ID 297 Response when wrong logindata result Invalid login or password Resp...

Page 100: ...e optional parameter text format response as text default xml format response as XML object test optional parameter 1 simulate message sending Messages with that parameter will not be added to outbox...

Page 101: ...when wrong parameters xml error_text Wrong or missing data parameter error_text status error status xml 10 Send binary SMS JSONRPC method HTTP POST METHOD https url of smseagle jsonrpc sms PARAMETERS...

Page 102: ...sponse result OK ID 297 Response when wrong logindata result Invalid login or password Response when wrong access token result Invalid access token Response when wrong parameters result Wrong or missi...

Page 103: ...eter how many messages to show unread optional parameter 1 show only unread messages responsetype optional parameter text format response as text default xml format response as XML object createdby op...

Page 104: ...ass 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...

Page 105: ...t ultrices et mi In ac felis urna Phasellus eget leo a leo congue ultricies Donec tincidunt volutpat arcu a commodo TextDecoded ID 126 ID RecipientID smseagle1 RecipientID Processed t Processed id_fol...

Page 106: ...TextDecoded Test test1 TextDecoded ID 574 ID SenderID smseagle1 SenderID SequencePosition 1 SequencePosition Status DeliveryOK Status StatusError 0 StatusError TPMR 84 TPMR RelativeValidity 255 Relat...

Page 107: ...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 S...

Page 108: ...ext 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...

Page 109: ...e content or state InsertIntoDB timestamp when message was inserted into database SendingDateTime timestamp when message has been sent DeliveryDateTime timestamp time of receiving a delivery report if...

Page 110: ...operator or instead use the field DeliveryDateTime StatusError integer Status of delivery from delivery report message codes are defined in GSM specification 03 40 section 9 2 3 15 TP Status TPMR inte...

Page 111: ...responsetype optional parameter simple format response as simple object with one result field default extended format response as extended JSON object createdby optional parameter username or email if...

Page 112: ...eagle1 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 004C006F00720065006D002000690070...

Page 113: ...entitems folder result UpdatedInDB 2018 06 07 11 29 56 InsertIntoDB 2018 06 07 11 29 43 SendingDateTime 2018 06 07 11 29 56 DeliveryDateTime 2018 06 07 11 30 05 Text 0074006500730074 DestinationNumber...

Page 114: ...27 03 SendingDateTime 2018 07 18 14 27 13 DeliveryDateTime null Text 00540065007300740020007700690074006800200075006E00690063006F00640065002000 65006E0063006F00640069006E0067003A00200105014200F301190...

Page 115: ...umber 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 RelativeValid...

Page 116: ...onse when wrong access token result Invalid access token Response when wrong parameters result Wrong parameters RESPONSE EXTENDED Sample response inbox folder result messages UpdatedInDB 2018 07 18 14...

Page 117: ...06F0072002C0020006D0061006C00650073007500610064 006100200076006100720069007500730020006C006900670075006C0061002000680065006 E006400720065 SenderNumber 48123456787 Coding Default_No_Compression UDH 050...

Page 118: ...777 Class 127 TextDecoded ID 525 SenderID smseagle1 SequencePosition 1 Status SendingOK StatusError 1 TPMR 1 RelativeValidity 255 CreatorID admin id_folder 3 StatusCode 1 UpdatedInDB 2018 07 18 14 25...

Page 119: ...14 27 32 SendingDateTime 2018 07 18 14 27 36 DeliveryDateTime null Text 00540065007300740020006F006600200066006C0061007300680020006D00650073007300 6100670065 DestinationNumber 123456788 Coding Default...

Page 120: ...null Text 0054006500730074002000740065007300740031 DestinationNumber 48601000310 Coding Unicode_No_Compression UDH SMSCNumber Class 100 TextDecoded Test test1 ID 1174 SenderID smseagle1 SequencePosit...

Page 121: ...Data Header encoded using hex values SMSCNumber character varying 20 SMSC number Class integer SMS class 0 is flash SMS 1 is normal SMS 127 is USSD TextDecoded text decoded SMS text ID serial SMS uniq...

Page 122: ...stamp when somebody software user updated the message content or state InsertIntoDB timestamp when message was inserted into database SendingDateTime timestamp when message has been sent DeliveryDateT...

Page 123: ...very report message codes are defined in GSM specification 03 40 section 9 2 3 15 TP Status TPMR integer The Message Reference field TP MR as defined in GSM 03 40 RelativeValidity integer SMS relative...

Page 124: ...x sentitems idfrom minimal id of message idto maximal id of message responsetype optional parameter text format response as text default xml format response as XML object EXAMPLES Delete message with...

Page 125: ...login your user to login to SMSEagle see details in point API Authentication pass your password to login to SMSEagle folder one of the following inbox outbox sentitems idfrom minimal id of message id...

Page 126: ...r 15 Get outgoing queue length HTTP GET method HTTP GET METHOD https url of smseagle http_api get_queue_length Parameter Description access_token authentication access token see details in point API A...

Page 127: ...ponse when wrong parameters xml error_text Wrong parameters error_text status error status xml 16 Get outgoing queue length JSONRPC method HTTP POST METHOD CALL https url of smseagle jsonrpc sms Param...

Page 128: ...Response when wrong access token result error_text Invalid access token status error Response when wrong parameters result error_text Wrong parameters status error 17 Get inbox length HTTP GET method...

Page 129: ...ng logindata xml error_text Invalid login or password error_text status error status xml Response when wrong access token xml error_text Invalid Access token error_text status error status xml Respons...

Page 130: ...ber of messages in database Inbox folder status ok Sample response result inbox_length 3 status ok Response when wrong logindata result error_text Invalid login or password status error Response when...

Page 131: ...g parameters Wrong parameters RESPONSE XML Response xml sentitems_length number of messages in database Inbox folder sentitems_length status ok status xml Sample response xml sentitems_length 21 senti...

Page 132: ...sponse result number of messages in database Sentitems folder Sample response result 21 Response when wrong logindata result Invalid login or password Response when wrong access token result Invalid a...

Page 133: ...l access_token 0005gOjCOlMH8F2x modem_no 1 RESPONSE Response 3G 4G signal strength in percent values between 0 100 If 3G 4G modem is disconnected from cellular network method returns 1 Sample response...

Page 134: ..._no optional parameter modem number to be queried default 1 Used only in multimodem devices responsetype optional parameter simple format response as simple object with one result field default extend...

Page 135: ...oint API Authentication pass your password to login to SMSEagle groupname name for the created group public optional parameter 0 private group 1 public group responsetype optional parameter text forma...

Page 136: ...ter Description access_token authentication access token see details in point API Authentication login your user to login to SMSEagle see details in point API Authentication pass your password to logi...

Page 137: ...ttps url of smseagle http_api group_read Parameter Description access_token authentication access token see details in point API Authentication login your user to login to SMSEagle see details in poin...

Page 138: ...r 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_te...

Page 139: ...te group default value 1 public group uid optional parameter id of user who created the group responsetype optional parameter simple format response as simple object with one result field default exte...

Page 140: ...er status error result error_text Wrong or missing public parameter status error 27 Phonebook group update HTTP GET method HTTP GET METHOD https url of smseagle http_api group_update Parameter Descrip...

Page 141: ...e xml status ok status xml Response when wrong logindata xml error_text Invalid login or password error_text status error status xml Response when wrong access token xml error_text Invalid Access toke...

Page 142: ...phonebook group_update params access_token 0005gOjCOlMH8F2x group_id 2 groupname myu sers public 1 RESPONSE Response result OK Response when wrong logindata result Invalid login or password Response...

Page 143: ...me of existing group responsetype optional parameter text format response as text default xml format response as XML object EXAMPLES https url of smseagle http_api group_delete access_token 0005gOjCOl...

Page 144: ...ml 30 Phonebook group delete JSONRPC method HTTP POST METHOD https url of smseagle jsonrpc sms Parameter Description access_token authentication access token see details in point API Authentication lo...

Page 145: ...rameter status error result error_text Wrong or missing group_id parameter status error Response when group_id is wrong result error_text Group with the given id does not exists status error 31 Phoneb...

Page 146: ...RESPONSE XML Response xml status ok status xml Response when wrong logindata xml error_text Invalid login or password error_text status error status xml Response when wrong access token xml error_tex...

Page 147: ...nsetype optional parameter simple format response as simple object with one result field default extended format response as extended JSON object EXAMPLES method phonebook group_addcontact params acce...

Page 148: ...ess_token authentication access token see details in point API Authentication login your user to login to SMSEagle see details in point API Authentication pass your password to login to SMSEagle group...

Page 149: ...ess token xml error_text Invalid Access token error_text status error status xml Response when wrong parameters xml error_text Wrong or missing group_id parameter error_text status error status xml xm...

Page 150: ...k group_removecontact params access_token 0005gOjCOlMH8F2x group_id 2 contact_id 1 RESPONSE Response result OK Response when wrong logindata result Invalid login or password Response when wrong access...

Page 151: ...the created contact number telephone number for the created contact public optional parameter 0 private contact 1 public contact default value responsetype optional parameter text format response as...

Page 152: ...rameter error_text status error status xml 36 Phonebook contact create JSONRPC method HTTP POST METHOD https url of smseagle jsonrpc sms Parameter Description access_token authentication access token...

Page 153: ...tus ok Response when wrong logindata result error_text Invalid login or password status error Response when wrong access token result error_text Invalid access token status error Response when wrong p...

Page 154: ...sword Response when wrong access token Invalid access token Response when wrong parameters Wrong or missing uid parameter Wrong or missing public parameter RESPONSE XML Sample response xml contacts it...

Page 155: ...error_text Wrong or missing uid parameter error_text status error status xml xml error_text Wrong or missing public parameter error_text status error status xml 38 Phonebook contact read JSONRPC metho...

Page 156: ...alse Response when no data result No data to display Response when wrong logindata result Invalid login or password Response when wrong access token result Invalid access token Response when wrong par...

Page 157: ...nt API Authentication pass your password to login to SMSEagle contact_id id of existing contact contactname name for the contact number phone number for the contact public optional parameter 0 private...

Page 158: ...text status error status xml Response when wrong parameters xml error_text Wrong or missing contactname parameter error_text status error status xml xml error_text Wrong or missing contact_id paramete...

Page 159: ...d number 123456789 public 1 RESPONSE Response result OK Response when wrong logindata result Invalid login or password Response when wrong access token result Invalid access token Response when wrong...

Page 160: ...me of existing contact responsetype optional parameter text format response as text default xml format response as XML object EXAMPLES https url of smseagle http_api contact_delete access_token 0005gO...

Page 161: ...us error status xml 42 Phonebook contact delete JSONRPC method HTTP POST METHOD https url of smseagle jsonrpc sms Parameter Description access_token authentication access token see details in point AP...

Page 162: ...ong parameters result error_text Wrong or missing contactname parameter status error result error_text Wrong or missing contact_id parameter status error Response when contact_id is wrong result error...

Page 163: ...ng to parameter Wrong or missing duration parameter Response when modem_no is wrong Modem not recognized RESPONSE XML Response xml status ok status xml Response when wrong logindata xml error_text Inv...

Page 164: ...em_no optional parameter calling modem number only for multimodem devices responsetype optional parameter simple format response as simple object with one result field default extended format response...

Page 165: ...h voice modem 45 Phonebook shift create HTTP GET method HTTP GET METHOD https url of smseagle http_api shift_create Parameter Description access_token authentication access token see details in point...

Page 166: ...text Invalid login or password error_text status error status xml Response when wrong access token xml error_text Invalid Access token error_text status error status xml Response when wrong parameters...

Page 167: ...Invalid login or password Response when wrong access token result Invalid access token Response when wrong parameters result Wrong or missing name parameter RESPONSE EXTENDED Response result shift_id...

Page 168: ...oken 0005gOjCOlMH8F2x name myshift RESPONSE Sample response link Response when no data No data to display Response when wrong logindata Invalid login or password Response when wrong access token Inval...

Page 169: ...or_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 m...

Page 170: ...00 tue_from null tue_to null wed_from 09 00 wed_to 20 00 thu_from null thu_to null fri_from null fri_to null sat_from null sat_to null sun_from null sun_to null enabled true Response when no data res...

Page 171: ...esponse when wrong parameters result error_text Wrong enabled parameter status error result error_text Wrong shift_id parameter status error 49 Phonebook shift update HTTP GET method HTTP GET METHOD h...

Page 172: ...wrong Shift with the given id does not exists RESPONSE XML Response xml status ok status xml Response when wrong logindata xml error_text Invalid login or password error_text status error status xml R...

Page 173: ...object EXAMPLES method phonebook shift_update params access_token 0005gOjCOlMH8F2x shift_id 24 name updated shift enabled 1 RESPONSE Response result OK Response when wrong logindata result Invalid lo...

Page 174: ...pass your password to login to SMSEagle shift_id id of existing shift responsetype optional parameter text format response as text default xml format response as XML object EXAMPLES https url of smse...

Page 175: ...n access_token authentication access token see details in point API Authentication login your user to login to SMSEagle see details in point API Authentication pass your password to login to SMSEagle...

Page 176: ...ttp_api shift_addcontact Parameter Description access_token authentication access token see details in point API Authentication login your user to login to SMSEagle see details in point API Authentica...

Page 177: ...hen wrong access token xml error_text Invalid Access token error_text status error status xml Response when wrong parameters xml error_text Wrong or missing shift_id parameter error_text status error...

Page 178: ...hift_addcontact params access_token 0005gOjCOlMH8F2x shift_id 24 contact_id 1 RESPONSE Response result OK Response when wrong logindata result Invalid login or password Response when wrong access toke...

Page 179: ...Eagle 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 xm...

Page 180: ...or_text status error status xml Response when id is wrong xml error_text Shift with the given id does not exists error_text status error status xml xml error_text Contact with the given id does not ex...

Page 181: ...tact_id parameter Response when id is wrong result Shift with the given id does not exists result Contact with the given id does not exists RESPONSE EXTENDED Response result status ok Response when wr...

Page 182: ...esponse as XML object EXAMPLES https url of smseagle http_api get_modem_state access_token 0005gOjCOlMH8F2x modem_no 1 RESPONSE Response enabled disabled Sample response enabled Response when wrong lo...

Page 183: ...password to login to SMSEagle modem_no optional parameter modem number to be queried default 1 Used only in multimodem devices responsetype optional parameter simple format response as simple object...

Page 184: ...MSEagle see details in point API Authentication pass your password to login to SMSEagle modem_no optional parameter modem number for status change default 1 Used only in multimodem devices status enab...

Page 185: ...method HTTP POST METHOD https url of smseagle jsonrpc sms Parameter Description access_token authentication access token see details in point API Authentication login your user to login to SMSEagle se...

Page 186: ...g access token result error_text Invalid access token status error Response when modem doesn t exist result error_text Wrong modem number status error Response when wrong modem state result error_text...

Page 187: ...ng username parameter error_text status error status xml 62 User ID read JSONRPC method HTTP POST METHOD https url of smseagle jsonrpc sms Parameter Description access_token authentication access toke...

Page 188: ...sponse when user doesn t exist result error_text Wrong username parameter status error 63 Group members read HTTP GET method HTTP GET METHOD https url of smseagle http_api group_members_read Parameter...

Page 189: ...456 Number id_user 1 id_user is_public true is_public contact contact ID 24 ID Name mycontact3 Name Number 12345 Number id_user 3 id_user is_public false is_public contact contacts xml Response when w...

Page 190: ...ield default extended format response as extended JSON object BODY method phonebook group_members_read params access_token 0005gOjCOlMH8F2x group_id 11 RESPONSE Sample response result ID 1706 Name myc...

Page 191: ...cription access_token authentication access token see details in point API Authentication login your user to login to SMSEagle see details in point API Authentication pass your password to login to SM...

Page 192: ...result field default extended format response as extended JSON object BODY method phone call_forward_read params access_token 0005gOjCOlMH8F2x modem_no 1 RESPONSE Sample response result 0 call forward...

Page 193: ...call_forward_set access_token 0005gOjCOlMH8F2x modem_no 1 modem_no 2 status 1 number 1234567 RESPONSE Sample response OK Response when modem returns wrong response error Response when wrong modem_no...

Page 194: ...rs RESPONSE EXTENDED Sample response result status ok Response when wrong parameters result error_text Wrong parameters status error 69 Phonebook contact set vacation mode HTTP GET method HTTP GET MET...

Page 195: ...token xml error_text Invalid Access token error_text status error status xml Response when wrong status xml error_text Wrong parameters error_text status error status xml 70 Phonebook contact set vaca...

Page 196: ...le response result vacation_mode enabled status ok Response when wrong logindata result error_text Invalid login or password status error Response when wrong access token result error_text Invalid acc...

Page 197: ...ponse when wrong access token Invalid access token RESPONSE XML Response xml vacation_mode enabled disabled vacation_mode status ok status xml Sample response xml vacation_mode enabled vacation_mode s...

Page 198: ...e object with one result field default extended format response as extended JSON object BODY method phonebook get_contact_vacation_mode params access_token 0005gOjCOlMH8F2x contact_id 4 contactname jo...

Page 199: ...ugins 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 p...

Page 200: ...Status contains information on delivery status Using API Use method read_sms to fetch data for a selected SMS in sentitems folder The data will contain columns Status and DeliveryDateTime contain inf...

Page 201: ...r TextDecoded CreatorID Coding Class SenderID VALUES 1234567 This is a SQL test message Program Default_No_Compression 1 smseagle1 INSERT INTO user_outbox id_outbox id_user SELECT CURRVAL pg_get_seria...

Page 202: ...d byte for number of current message 01 for first message 02 for second etc For example long text message of two parts could look like following INSERT INTO outbox DestinationNumber CreatorID MultiPar...

Page 203: ...03 SMSEagle NXS 9700 User s Manual CURRVAL pg_get_serial_sequence outbox ID 1 Note Adding UDH means that you have less space for text in above example you can use only 153 characters in single message...

Page 204: ...older than 7 days Usage db_delete_7days db_delete_allfolders script for cleaning PostgreSQL database folders Inbox SentItems Outbox Specially designed to run periodically through cron Usage db_delete_...

Page 205: ...6 1 4 1 8072 1 3 2 3 1 2 12 71 83 77 95 78 101 116 78 97 109 1 01 49 FolderOutbox_Total Returns number of SMS messages in Outbox folder outgoing queue length 1 3 6 1 4 1 8072 1 3 2 3 1 2 18 70 111 108...

Page 206: ...lt value for parameter GSM_Signal NET SNMP EXTEND MIB nsExtendOutputFull GSM_Signal If your chosen SNMP tool cannot access NET SNMP EXTEND MIB objects you can download MIB definitions from https www s...

Page 207: ...IBRARY a Command for reading the result value snmpget v 2c c public ip of smseagle system sysUpTime 0 Result DISMAN EVENT MIB sysUpTimeInstance Timeticks 216622 0 36 06 22 Comment Linux system is up f...

Page 208: ...r is not mandatory To easily switch to SNMP v3 access control we ve prepared special shell script located at mnt nand user smseagle directory 1 Log in via SSH using root account 2 Navigate to cd mnt n...

Page 209: ...209 SMSEagle NXS 9700 User s Manual 7 To disable v2 access policy run snmpv3 disablev2 8 To enable v2 access policy run snmpv3 enablev2...

Page 210: ...syslog conf At the bottom of the configuration file add action type omfwd target SERVER_IP port PORT protocol PROTOCOL action resumeRetryCount 10 queue type linkedList queue size 10000 where SERVER_IP...

Page 211: ...d with information if it is up to date AUTOMATIC CHECK In order to start automatic checks for software updates go to menu Settings tab Maintenance and check the option Automatically check for software...

Page 212: ...NXS 9700 User s Manual Knowledgebase Support Portal More information and useful hints about SMSEagle device configuration can be found in our online knowledgebase and support portal at https support...

Page 213: ...213 SMSEagle NXS 9700 User s Manual TROUBLESHOOTING I I I...

Page 214: ...linking SIM1 only 3G device Slow flashing in stand by mode Quick flashing when modem 1 in use SIM2 only 3G device Not used Checking the device information The device information device type software v...

Page 215: ...possible to restore to factory IP settings by using the SW button Restoring factory defaults This action restores the following settings to default values IP settings time zone settings database conte...

Page 216: ...ual 4 Wait until system reboots Default settings are restored System is going for a reboot Please note that after reboot the device will be finishing the process of factory reset therefore it can take...

Page 217: ...217 SMSEagle NXS 9700 User s Manual SERVICE REPAIR IV...

Page 218: ...fore contacting with support team be sure that you have read Troubleshooting section of this manual SMSEagle Support Team is available by email or telephone Support Portal https support smseagle eu Em...

Page 219: ...219 SMSEagle NXS 9700 User s Manual TECH SPECS SAFETY INFORMATION V...

Page 220: ...hardware Rev 1 3 4GB Network interface Ethernet 1xRJ45 o hardware Re 4 Rev 3 Gigabit Ethernet 10 100 1000 TX o hardware Rev 2 Rev 1 Fast Ethernet 10 100 TX 1x HDMI port for debugging purposes Other ex...

Page 221: ...o UMTS B1 B2 B4 B5 B6 B8 B19 o GSM B2 B3 B5 B8 optional o Output power Rated Class 3 23dBm 2dB for LTE FDD LTE TDD bands Class 3 24dBm 1 3dB for WCDMA bands Class 4 33dBm 2dB for GSM850 EGSM900 Class...

Page 222: ...12Vdc min 3 3A PS2 LPS Limited Power Source AC line input Voltage ranges 100 240V alternating current AC Frequency 50 60Hz single phase DC plug type 5 5 2 5 o Alternative power source PoE IEEE 802 3at...

Page 223: ...sion rate up to 30 SMS min Outgoing transmission rate up to 30 SMS min SOFTWARE PLATFORM Operating system Linux o hardware Rev 4 kernel 5 1x o hardware Rev 3 kernel 4 14 o hardware Rev 2 kernel 4 4 o...

Page 224: ...ent the use of this product may be dangerous and has to be avoided in the following areas where it can interfere with other electronic devices located in close proximity in environments such as hospit...

Page 225: ...termined by turning the equipment off and on the user is encouraged to try to correct the interference by one or more of the following measures Reorient or relocate the receiving antenna Increase the...

Page 226: ...as produire de brouillage 2 l utilisateur de l appareil doit accepter tout brouillage radio lectrique subi m me si le brouillage est susceptible d en compromettre le fonctionnement Cet appareil num ri...

Page 227: ...sh to discard this product please contact your local authorities or dealer and ask for the correct method of disposal Information gem 4 Absatz 4 Elektrogesetz DE Folgende Batterien bzw Akkumulatoren s...

Page 228: ...kkumulator und das Ger t k nnen jetzt getrennt entsorgt werden Restriction of Hazardous Substances Directive RoHS European Union RoHS SMSEagle devices sold in the European Union on or after 3 January...

Page 229: ...229 SMSEagle NXS 9700 User s Manual Proximus Sp z o o Ul Pi tkowska 163 60 650 Pozna Poland l Europe T 48 61 6713 413 E hello smseagle eu www smseagle eu...

Search results

Summary of Contents for NXS-9700-3G

Reviews:

Related manuals for NXS-9700-3G

Brands by name

Popular brands

SMSEagle NXS-9700-3G, User Manual

Search results

Summary of Contents for NXS-9700-3G

Reviews:

Related manuals for NXS-9700-3G

Brands by name

Popular brands