background image

 

 

 

User’s Manual

 

SMSEAGLE

 

NXS-9700

 

Summary of Contents for NXS-9700

Page 1: ...User s Manual SMSEAGLE NXS 9700...

Page 2: ...aterials 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...

Page 3: ...ew 18 SMSEagle plugins 19 Autoreply plugin 19 Network Monitoring plugin 20 Email to SMS plugin 23 Email to SMS Poller 26 SMS to Email plugin 28 Callback URL plugin 30 SMS Forward 31 Periodic SMS 32 Di...

Page 4: ...entitems length JSONRPC method 81 21 Get GSM 3G signal strength HTTP GET method 82 22 Get GSM 3G signal strength JSONRPC method 83 23 Phonebook group create HTTP GET method 84 24 Phonebook group creat...

Page 5: ...JSONRPC method 115 49 Phonebook shift update HTTP GET method 117 50 Phonebook shift update JSONRPC method 118 51 Phonebook shift delete HTTP GET method 119 52 Phonebook shift delete JSONRPC method 12...

Page 6: ...software updates checks 150 Troubleshooting 152 Verification of LEDs 152 Checking the device logs 152 When the device is not reachable 152 Restoring factory defaults 153 Service Repair 156 Warranty 15...

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

Page 8: ...700 3G User s Manual WHAT S IN THE BOX Your SMSEagle box contains SMSEagle hardware SMS gateway External omnidirectional 3dBi GSM 3G antenna with magnetic foot AC DC power supply input voltage 100 240...

Page 9: ...ing in conjunction with any other antenna or transmitter The antenna must not be installed inside metal cases Plug in 3G antenna connector to the device STEP 2 Insert SIM Card Please install SIM Card...

Page 10: ...keyboard to USB port note cables are not provided login to the SSH console using root credentials these were provided with your device edit configuration file with command mcedit mnt nand user smseagl...

Page 11: ...o 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 12: ...PIN This step should ONLY be done if your SIM card requires PIN If your SIM card requires PIN number at startup go to Settings Maintenance Tab Enter your PIN number in the field SIM Card PIN STEP 6 R...

Page 13: ...13 SMSEagle NXS 9700 3G User s Manual USING OF SMSEAGLE II...

Page 14: ...le not included USB port USB USB port cable not included Ethernet Port ETH Ethernet RJ45 socket Antenna ANT Antenna socket Power LED PWR LED indicating power on User LED USER LED for user application...

Page 15: ...tions 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 scree...

Page 16: ...templates Different message types normal SMS flash WAP push USSD codes Unicode support support of national characters Multiuser support each user has access to a private Inbox Outbox Sent Items Phone...

Page 17: ...dd edit delete groups Set groups to public or private visbility View group content contacts beloning to the group Send message to a group Phonebook Working Shifts The Shift management feature allows t...

Page 18: ...rs based on custom criteria and display filtered messages Filtered list of messages can be exported to PDF or CSV file Screenshot of Reporting module Statistics view The reporting module allows also t...

Page 19: ...ugin allows 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 b...

Page 20: ...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 M...

Page 21: ...ice is currently unavailable see when a specific server service was last down last downtime check what happened at last downtime see server service response edit delete your tasks disable tasks when n...

Page 22: ...increase a default timeout value for busy servers by default we set it to 30 seconds Define a schedule choose if task should be always enabled or disable it in chosen times during a night when a mach...

Page 23: ...act quickly Go to our website www smseagle eu for more details of this plugin Email to SMS plugin Email To SMS plugin allows you to convert an email to SMS message BASIC USAGE If the plugin is enabled...

Page 24: ...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 EMAIL SUBJECT AD...

Page 25: ...setting to Use for authentication If user authentication is enabled provide in a subject of an email your login and password in the following form login john pass doe if you want to include only a su...

Page 26: ...mma or phonebook contact group name BASIC EXAMPLE For example such email message TO smseagle mycompany com FROM john doe mycompany com SUBJECT 48333444555 BODY Hello world In this case SMSEagle gatewa...

Page 27: ...mail fetching interval in seconds the text of an email will be cropped to the value Maximum number of characters Maximum allowed length of SMS message is 1300 characters If you want to include special...

Page 28: ...wo 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 incom...

Page 29: ...forwarding To email of last sending user so called Two way Email2SMS SMS Email or To fixed email address enter an email subject enter SMTP configuration for your SMTP server that will be used for send...

Page 30: ...fields URL field defines remote address of your callback script Test URL button allows to test whether your Callback URL configuration is correct SMSEagle will make a callback request with test parame...

Page 31: ...s received from your callback URL SMSEagle will keep retrying every 2 minutes for 24 hours SMS Forward The plugin SMS forward allows to forward incoming SMS messages to one may recipients according to...

Page 32: ...an be either phone number or name of group from phonebook User may define many forwarding rules in the plugin Each rule is processed independently There is a possibility to enable disable each rule Sc...

Page 33: ...SMS USSD Code The content of the SMS text The recipients phone number s separated with comma or group s from phonebook Screenshot from Add new rule window Digital input output The NXS family of SMSEag...

Page 34: ...cal level Voltage LOW 0 0 V HIGH 1 5V 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 d...

Page 35: ...e rule name Port number 1 2 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 va...

Page 36: ...s a current efficiency of 200mA Consider using a relay for high power output devices Temperature humidity sensor The NXS family of SMSEagle devices is equipped with internal temperature and humidity s...

Page 37: ...rature 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 currently only 1 sensor is a...

Page 38: ...s Manual 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 Sc...

Page 39: ...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...

Page 40: ...les of web gui 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...

Page 41: ...null SMS will be scheduled for sending at the given date and time highpriority optional parameter 0 normal priority 1 SMS will have higher priority in Outbox queue when processed by GSM modem unicode...

Page 42: ..._sms login john pass doe to 1234567 message mymessage highpriority 1 RESPONSE Response OK ID ID of message in outbox Sample response OK ID 297 Response when wrong logindata Invalid login or password R...

Page 43: ...e you can send national characters flash optional parameter 0 normal SMS default 1 SMS will be sent as flash message oid optional parameter This attribute specifies a user defined unique ID that is as...

Page 44: ...ponse result message_id 748 status ok Sample response when parameter to contains multiple phone numbers result message_id 3643 status ok message_id 3644 status ok message_id 3645 status ok message_id...

Page 45: ...ultimodem 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 send_togroup login john pass...

Page 46: ...our 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 priority in Outbox que...

Page 47: ...status error Response when wrong parameters result error_text Wrong parameters status error 5 Send SMS to contact HTTP GET method HTTP GET METHOD https url of smseagle index php http_api send_toconta...

Page 48: ...smseagle index php http_api send_tocontact login john pass doe contactname johndoe message mymessage date 201401152132 https url of smseagle index php http_api send_tocontact login john pass doe conta...

Page 49: ...HHMM 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 priority 1 SMS will...

Page 50: ...ters RESPONSE EXTENDED Response result message_id ID of message in outbox status ok Sample response result message_id 748 status ok Response when wrong logindata result error_text Invalid login or pas...

Page 51: ...sword 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...

Page 52: ...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 Response when wrong parameters result Wron...

Page 53: ...EXAMPLES https url of smseagle index php http_api send_binary_sms login john pass doe to 1234567 udh 0605040B8423F0 data EA0601AE02056A0045C6 0C037777772E736D736561676C652E657500080103534D534561676C65...

Page 54: ...lephone number or numbers separated with comma udh optional parameter UDH header for the message in hex format data binary message in hex format class optional parameter message class modem_no optiona...

Page 55: ...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 idfro...

Page 56: ...how messages from sentitems folder with receiver phone number 7654321 and datetime from 2014 12 24 08 10 00 to 2014 12 31 23 59 59 https url of smseagle index php http_api read_sms login john pass doe...

Page 57: ...E00740075006D0020007500 6C006C0061006D0063006F007200700065007200200065006700650073007400610073002E0 020004E0075006C006C006100200070006C006100630065007200610074002000660069006E 006900620075007300200064...

Page 58: ...SendingDateTime DeliveryDateTime DeliveryDateTime Text Text DestinationNumber 101 DestinationNumber Coding 8bit Coding UDH UDH SMSCNumber 48501200777 SMSCNumber Class 127 Class TextDecoded TextDecode...

Page 59: ..._folder StatusCode 1 StatusCode item item UpdatedInDB 2018 07 18 14 27 36 UpdatedInDB InsertIntoDB 2018 07 18 14 27 32 InsertIntoDB SendingDateTime 2018 07 18 14 27 36 SendingDateTime DeliveryDateTime...

Page 60: ...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 xml error_te...

Page 61: ...ation see send_sms method description Status integer Status of incoming message Currently only used for USSD messages with following meaning 1 Unknown status 2 No action is needed maybe network initia...

Page 62: ...ived and reports failure DeliveryPending Delivery report announced pending deliver DeliveryUnknown Delivery report reported unknown status Error Some other error happened during sending Notice some ce...

Page 63: ...ur MM minutes SS seconds Show only messages sent received on this date time and later dateto optional parameter date and time in format YYYYmmDDHHMMSS YYYY year mm month DD day HH hour MM minutes SS s...

Page 64: ...tDecoded Test 1 ID 124 RecipientID smseagle1 Processed t id_folder 1 readed true oid Status 0 UpdatedInDB 2018 07 18 13 56 16 ReceivingDateTime 2018 07 17 15 04 10 Text 005400650073007400200032 Sender...

Page 65: ...vestibulum ac aliquam eget ultrices et mi In ac felis urna Phasellus eget leo a leo congue ultricies Donec tincidunt volutpat arcu a commodo ID 126 RecipientID smseagle1 Processed t id_folder 1 readed...

Page 66: ...1 SequencePosition 1 Status DeliveryOK StatusError 0 TPMR 84 RelativeValidity 255 CreatorID admin id_folder 3 StatusCode 1 UpdatedInDB 2018 07 18 14 27 13 InsertIntoDB 2018 07 18 14 27 03 SendingDateT...

Page 67: ...4 29 29 InsertIntoDB 2018 07 18 14 28 46 SendingDateTime 2018 07 18 14 29 29 DeliveryDateTime null Text 0054006500730074002000770069007400680020006200610064002000700068006F006E00 650020006E0075006D006...

Page 68: ...C00200063006F006E0073006500630074006500740 0750072002000610064006900700069007300630069006E006700200065006C00690074002E 002000430072006100730020006600650072006D0065006E00740075006D00200075006C006 C0061...

Page 69: ..._No_Compression UDH SMSCNumber 48501200777 Class 1 TextDecoded test ID 456 SenderID smseagle1 SequencePosition 1 Status DeliveryOK StatusError 1 TPMR 116 RelativeValidity 255 CreatorID admin id_folder...

Page 70: ...eTime null Text 00540065007300740020007700690074006800200075006E00690063006F00640065002000 65006E0063006F00640069006E0067003A00200105014200F30119017A0107 DestinationNumber 123456788 Coding Unicode_No_...

Page 71: ...tion 1 Status SendingError StatusError 1 TPMR 1 RelativeValidity 255 CreatorID admin id_folder 3 StatusCode 21 status ok Response when no data result error_text No data to display status error Respons...

Page 72: ...a particular recipient particular phone number More information see send_sms method description Status integer Status of incoming message Currently only used for USSD messages with following meaning 1...

Page 73: ...arrived and reported success DeliveryFailed Delivery report arrived and reports failure DeliveryPending Delivery report announced pending deliver DeliveryUnknown Delivery report reported unknown stat...

Page 74: ...optional parameter text format response as text default xml format response as XML object EXAMPLES Delete message with id 1234 from inbox https url of smseagle index php http_api delete_sms login joh...

Page 75: ...l id of message responsetype optional parameter simple format response as simple object with one result field default extended format response as extended JSON object EXAMPLES Delete message with id 1...

Page 76: ...SEagle 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...

Page 77: ...iption 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 forma...

Page 78: ...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 inde...

Page 79: ...agle 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 EXAM...

Page 80: ...ameter text format response as text default xml format response as XML object EXAMPLES https url of smseagle index php http_api get_sentitems_length login john pass doe RESPONSE Response number of mes...

Page 81: ...extended format response as extended JSON object EXAMPLES method sms get_sentitems_length params login john pass doe RESPONSE Response result number of messages in database Sentitems folder Sample res...

Page 82: ...ject EXAMPLES https url of smseagle index php http_api get_gsmsignal login john pass doe modem_no 1 RESPONSE Response GSM 3G signal strength in percent values between 0 100 If 3G modem is disconnected...

Page 83: ...onal parameter simple format response as simple object with one result field default extended format response as extended JSON object BODY method signal get_gsmsignal params login john pass doe RESPON...

Page 84: ...ormat response as XML object EXAMPLES https url of smseagle index php http_api group_create login john pass doe groupname myusers public 1 RESPONSE Response OK ID ID of created group Sample response O...

Page 85: ...bject with one result field default extended format response as extended JSON object EXAMPLES method phonebook group_create params login john pass doe groupname myusers public 1 RESPONSE Response resu...

Page 86: ...parameter text format response as text default xml format response as XML object EXAMPLES https url of smseagle index php http_api group_read login john pass doe public 1 uid 12 RESPONSE Sample respon...

Page 87: ...onse when wrong parameters xml error_text Wrong or missing uid parameter error_text status error status xml Response when wrong parameters xml error_text Wrong or missing public parameter error_text s...

Page 88: ...assword Response when wrong parameters result Wrong or missing uid parameter result Wrong or missing public parameter RESPONSE EXTENDED Sample response result groups Name private ID 2 id_user 1 is_pub...

Page 89: ...oup_id 2 groupname myusers public 1 RESPONSE Response OK Response when wrong logindata Invalid login or password Response when wrong parameters Wrong or missing groupname parameter Wrong or missing gr...

Page 90: ...oup responsetype optional parameter simple format response as simple object with one result field default extended format response as extended JSON object EXAMPLES method phonebook group_update params...

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

Page 92: ...h the given id does not exists error_text 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...

Page 93: ...eter status error Response when group_id is wrong result error_text Group with the given id does not exists status error 31 Phonebook group add contact HTTP GET method HTTP GET METHOD https url of sms...

Page 94: ...xt status error status xml Response when wrong parameters xml error_text Wrong or missing group_id parameter error_text status error status xml xml error_text Wrong or missing contact_id parameter err...

Page 95: ...logindata result Invalid login or password Response when wrong parameters result Wrong or missing group_id parameter result Wrong or missing contact_id parameter Response when id is wrong result Grou...

Page 96: ...esponse as XML object EXAMPLES https url of smseagle index php http_api group_removecontact login john pass doe group_id 2 contact_id 1 RESPONSE Response OK Response when wrong logindata Invalid login...

Page 97: ...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 g...

Page 98: ...id does not exists status error 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 SM...

Page 99: ...a xml error_text Invalid login or password error_text status error status xml Response when wrong parameters xml error_text Wrong or missing contactname parameter error_text status error status xml xm...

Page 100: ...onse when wrong parameters result Wrong or missing contactname parameter result Wrong or missing number parameter RESPONSE EXTENDED Response result contact_id ID of created contact status ok Sample re...

Page 101: ...isplay Response when wrong logindata Invalid login or password Response when wrong parameters Wrong or missing uid parameter Wrong or missing public parameter RESPONSE XML Sample response xml contacts...

Page 102: ...s xml xml error_text Wrong or missing public parameter error_text status error status xml 38 Phonebook contact read JSONRPC method HTTP POST METHOD https url of smseagle index php jsonrpc sms Paramete...

Page 103: ...en wrong parameters result Wrong or missing uid parameter result Wrong or missing public parameter RESPONSE EXTENDED Sample response result contacts ID 2 GroupID 1 Name John Doe Number 123123123 id_us...

Page 104: ...at response as text default xml format response as XML object EXAMPLES https url of smseagle index php http_api contact_update login john pass doe contact_id 4 contactname johnlord number 123456789 pu...

Page 105: ...us 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...

Page 106: ...ctname parameter status error result error_text Wrong or missing contact_id parameter status error result error_text Wrong or missing number parameter status error Response when contact_id is wrong re...

Page 107: ...l 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 contactname parameter error_t...

Page 108: ...d Response when wrong parameters result Wrong or missing contactname parameter result Wrong or missing contact_id parameter Response when contact_id is wrong result Contact with the given id and name...

Page 109: ...oe to 123456789 duration 5 RESPONSE Response OK Response when wrong logindata Invalid login or password Response when modem doesn t support voice calls This modem doesn t support voice calls Response...

Page 110: ...Eagle to 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 a...

Page 111: ...ce this method is available only for devices with 3G voice modem 45 Phonebook shift create HTTP GET method HTTP GET METHOD https url of smseagle index php http_api shift_create Parameter Description l...

Page 112: ...ext status error status xml Response when wrong parameters xml error_text Wrong or missing name parameter error_text status error status xml 46 Phonebook shift create JSONRPC method HTTP POST METHOD h...

Page 113: ...tus ok Response when wrong logindata result error_text Invalid login or password status error Response when wrong parameters result error_text Wrong or missing name parameter status error 47 Phonebook...

Page 114: ...hift id_shift 62 id_shift name myshift name mon_from 08 00 mon_from mon_to 16 00 mon_to tue_from tue_to wed_from 09 00 wed_from wed_to 20 00 wed_to thu_from thu_to fri_from fri_to sat_from sat_to sun_...

Page 115: ...ms 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 shift_id option...

Page 116: ...se when wrong parameters result Wrong enabled parameter result Wrong shift_id parameter RESPONSE EXTENDED Sample response result shifts id_shift 62 name myshift mon_from 08 00 mon_to 16 00 tue_from nu...

Page 117: ...MSEagle shift_id id of existing shift name name for the shift enabled 0 disabled 1 enabled responsetype optional parameter text format response as text default xml format response as XML object EXAMPL...

Page 118: ...n id does not exists error_text status error status xml 50 Phonebook shift update JSONRPC method HTTP POST METHOD https url of smseagle index php jsonrpc sms Parameter Description login your user to l...

Page 119: ...result error_text Wrong or missing shift_id parameter status error Response when shift_id is wrong result error_text Shift with the given id does not exists status error 51 Phonebook shift delete HTT...

Page 120: ...t status error status xml Response when shift_id is wrong xml error_text Shift with the given id does not exists error_text status error status xml 52 Phonebook shift delete JSONRPC method HTTP POST M...

Page 121: ...ext Shift with the given id does not exists status error 53 Phonebook shift add contact HTTP GET method HTTP GET METHOD https url of smseagle index php http_api shift_addcontact Parameter Description...

Page 122: ...atus xml Response when wrong parameters xml error_text Wrong or missing shift_id parameter error_text status error status xml xml error_text Wrong or missing contact_id parameter error_text status err...

Page 123: ...id login or password Response when wrong parameters result Wrong or missing shift_id parameter result Wrong or missing contact_id parameter Response when id is wrong result Shift with the given id doe...

Page 124: ...ponse as XML object EXAMPLES https url of smseagle index php http_api shift_removecontact login john pass doe shift_id 24 contact_id 1 RESPONSE Response OK Response when wrong logindata Invalid login...

Page 125: ...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...

Page 126: ...error_text Contact with the given id does not exists status error 57 Get modem state HTTP GET method HTTP GET METHOD https url of smseagle index php http_api get_modem_state Parameter Description logi...

Page 127: ...alid login or password error_text status error status xml Response when modem doesn t exist xml error_text Wrong modem number error_text status error status xml 58 Get modem state JSONRPC method HTTP...

Page 128: ...s ok Response when wrong logindata result error_text Invalid login or password status error Response when modem doesn t exist result error_text Wrong modem number status error 59 Set modem state HTTP...

Page 129: ...status error status xml Response when modem doesn t exist xml error_text Wrong modem number error_text status error status xml Response when wrong modem state xml error_text Wrong modem state error_t...

Page 130: ...esponse result modem_status Wrong modem number status ok Response when wrong logindata result error_text Invalid login or password status error Response when modem doesn t exist result error_text Wron...

Page 131: ...error_text status error status xml Response when user doesn t exist xml error_text Wrong username parameter error_text status error status xml 62 User ID read JSONRPC method HTTP POST METHOD https url...

Page 132: ...status error Response 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 index php http_api gro...

Page 133: ...3456 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...

Page 134: ...params login john pass doe group_id 11 RESPONSE Sample response result ID 1706 Name mycontact1 Number 23456 id_user 1 is_public true ID 1693 Name mycontact3 Number 12345 id_user 3 is_public false Res...

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

Page 136: ...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...

Page 137: ...the database from external application using the following credentials Injecting short SMS using SQL The simplest example is short text message limited to 160 chars INSERT INTO outbox DestinationNumb...

Page 138: ...e byte for number of messages 02 in example it should be unique for each message you send to same phone number and byte for number of current message 01 for first message 02 for second etc For example...

Page 139: ...Default_No_Compression 1 INSERT INTO user_outbox id_outbox id_user SELECT CURRVAL pg_get_serial_sequence outbox ID 1 Note Adding UDH means that you have less space for text in above example you can us...

Page 140: ...s 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_delet...

Page 141: ...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 100 101 114 79 117 11 6...

Page 142: ...In order to test read the parameter values from SNMP agent you can use any tools available for SNMP protocol for example NET SNMP library for Linux or iReasoning MiB Browser for Windows EXAMPLE OF REA...

Page 143: ...MAN 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...

Page 144: ...ase 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 nand user smseagle 3 Confi...

Page 145: ...145 SMSEagle NXS 9700 3G User s Manual 8 To enable v2 access policy run snmpv3 enablev2...

Page 146: ...ter 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 1 Apache2 WWW server 2 PostgreSQL dat...

Page 147: ...ss set Enable Failover cluster to Yes Save configuration Reboot each device after saving Screenshot from General settings Failover A device that boots first becomes MASTER in failover cluster second a...

Page 148: ...ou can always disable service with failover stop Above commands have to be done on each device node of HA cluster SNMP monitoring Failover feature uses KEEPALIVED MIB for SNMP monitoring EXAMPLE OF RE...

Page 149: ...logd configuration is managed using a configuration file located at etc rsyslog conf Forwarding all logs to external server using TCP port At the bottom of the configuration file add server_ip_address...

Page 150: ...red 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 softwa...

Page 151: ...151 SMSEagle NXS 9700 3G User s Manual TROUBLESHOOTING I I I I I I...

Page 152: ...r Blinks during flashdisk read write Ready RDY Blinking SIM1 Slow flashing in stand by mode Quick flashing when modem 1 in use SIM2 Not used Checking the device logs SMSEagle operates on Linux system...

Page 153: ...restores the following settings to default values IP settings time zone settings database content Linux OS users passwords In order to restore factory defaults proceed with the following steps LED sig...

Page 154: ...154 SMSEagle NXS 9700 3G User s Manual 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...

Page 155: ...155 SMSEagle NXS 9700 3G User s Manual SERVICE REPAIR IV I...

Page 156: ...leshooting section of this manual SMSEagle Support Team is available by email or telephone Support Email support smseagle eu Support telephone 48 61 6713 411 The support service is provided by Proximu...

Page 157: ...157 SMSEagle NXS 9700 3G User s Manual TECH SPECS SAFETY INFORMATION V I...

Page 158: ...Network interface Ethernet 10 100 TX 1xRJ45 4GB Flash disk 1x USB 2 0 port 1x HDMI port 2x RS232 serial ports 2x DO DI GPIO ports RTC Clock RTC 240B SRAM Watchdog timer Humidity temperature sensor Po...

Page 159: ...ctional 3 5dBi antenna with magnetic foot Cable length 3m SENDING RECEIVING THROUGHPUT Incoming transmission rate up to 30 SMS min Outgoing transmission rate up to 20 SMS min API send SMS requests 200...

Page 160: ...mmunication equipment 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 in environments such as hospitals airpo...

Page 161: ...which the receiver is connected Consult the dealer or an experienced radio TV technician for help Important This equipment generates uses and can radiate radio frequency energy and if not installed a...

Page 162: ...attery shall be disposed of separately from household waste When this product reaches its end of life take it to a collection point designated by local authorities The separate collection and recyclin...

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

Reviews: