1. Manuals
  2. Brands
  3. SMSEagle Manuals
  4. Gateway
  5. NPE-9300-GPRS/3G
  6. User manual

SMSEagle NPE-9300-GPRS/3G User Manual

Hardware sms gateway
Hide thumbs
Table of Contents

Advertisement

Quick Links

1
Page

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the NPE-9300-GPRS/3G and is the answer not in the manual?

Questions and answers

Related Manuals for SMSEagle NPE-9300-GPRS/3G

Summary of Contents for SMSEagle NPE-9300-GPRS/3G

  • Page 1 Page...
  • Page 2 Document version: 3.2 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 to change without prior notice being given. Page...

  • Page 3: Table Of Contents

    GET READY TO START ........................6 What’s in The BOX ..........................7 Prepare for first start ........................... 8 USING OF SMSEAGLE ........................13 Get to know with Connectors, Ports and LEDs .................. 14 Basic Operations ..........................15 SMSEagle basic features ........................15 Phonebook ............................
  • Page 4 40. Phonebook contact update: JSONRPC method ............... 84 41. Phonebook contact delete: HTTP GET method ............... 85 42. Phonebook contact delete: JSONRPC method ................ 86 Plugins and integration manuals for NMS & Auth systems .............. 88 Connecting directly to SMSEagle database ..................89 Page...
  • Page 5 Injecting short SMS using SQL ......................89 Injecting long SMS using SQL ......................90 Database cleaning scripts ........................92 SNMP agent ............................93 Setting up SNMP v3 access control ....................96 Forwarding logs to external server ....................97 Automatic software updates checks ....................98 TROUBLESHOOTING ........................

  • Page 6: Get Ready To Start

    1. GET READY TO START Page...

  • Page 7: What's In The Box

    What’s in The BOX Your SMSEagle box contains:  SMSEagle Hardware SMS Gateway  External omnidirectional 3.5dBi GSM antenna (with magnetic foot)  AC/DC power supply (input voltage: 100-240V)  Warranty card Page...

  • Page 8: 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. Step 1: Connect GSM antenna Plug in GSM antenna connector to the device.
  • Page 9 Step 4: Configure IP settings Follow the steps below in order to the device first time using Ethernet – with initial factory settings on the device. SMSEAGLE DEFAULT NETWORK CONFIGURATION The following configuration is set on a device by default: IP address: 192.168.0.101...
  • Page 10 Example of computer IP configuration in Windows: b) V ERIFY YOUR CONNECTION Properly connected device should respond to the ping command. Example of ping after a proper connection to PC c) L SMSE OG IN TO AGLE Page...
  • Page 11 Open an internet browser on your PC and go to the address: 192.168.0.101 SMSEAGLE DEFAULT USER IS Username: admin Password: password Login to application with above username and password. d) C ONFIGURE SETTINGS Click on menu position “Settings” and navigate to tab “IP Settings”.
  • Page 12 Enter your IP settings. If you have DHCP server on your network you can choose “Get IP address from DHCP” – IP settings will be obtained automatically. Press “Save” button. e) S SIM-CARD PIN ETTING NUMBER This step should ONLY be done if your SIM-card requires PIN. If your SIM-card requires PIN number at startup, go to Settings >...

  • Page 13: Using Of Smseagle

    2. USING OF SMSEAGLE Page...

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

    Get to know with Connectors, Ports and LEDs Element Label Description Connector 1 Power connector and serial ports Connector 2 Additional ports connector (not used) SIM Card Slot SIM card slot SD Card Slot Slot for additional SD/MMC card Ethernet Port Ethernet RJ45 socket Antenna Antenna socket...

  • 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 First Start.

  • Page 16: 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 17: Phonebook Working Shifts

    Phonebook Working Shifts The Shift management feature allows to assign Phonebook contacts to working shifts. If a contact is assigned to any working shift, before sending a message the device will check if the contact is on a working shift. If the contact is not on shift the message will be skipped or moved to beginning of a next shift.

  • Page 18: Statistics View

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

  • Page 19: Smseagle Plugins

    Basic features of SMSEagle software are extended by plugins that provide extra features to the software. Below you will find a description of plugins available in each SMSEagle device. All plugins are an integral part of SMSEagle software. That means that all described plugins are installed in a standard software of SMSEagle device and are available for free.

  • Page 20: Network Monitoring Plugin

    SMSEagle is equipped with powerful (yet simple to use) network services monitoring features. With that features you can monitor any service that has listening port open. SMSEagle is trying to connect to each defined port in Network Monitoring feature and sends defined SMS alert when port is unavailable. Below you will find a brief overview of plugin capabilities.
  • Page 21 Control status of all your defined tasks  see a settings’ overview for all of your tasks  check which server/service is currently unavailable  see when a specific server/service was last down (last downtime)  check what happened at last downtime (see server/service response) ...
  • Page 22  choose ICMP (ping) to monitor a server with ICMP protocol  or PORT (TCP/UDP) to monitor your service on a selected port (SMSEagle will check if port is open)  or SNMP to monitor objects via SNMP protocol (supported return types: numeric, string) ...
  • Page 23 {TIMESTAMP} – timestamp of an error Receive SMS alerts  be immediately alerted when your services/servers go down (or go up after failure)  give yourself a chance to react quickly Go to our website www.smseagle.eu for more details of this plugin. Page...

  • Page 24: Email To Sms Plugin

    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 25 If you send email with subject containing FLAG=VALUE the flag will be set for this particular email2SMS message. Example 1: email message with subject containing modem_no=2 will be converted to SMS message and sent via modem number 2. Example 2: email message with subject containing date=201801010005&modem_no=2 will be converted to SMS message and sent on 2018-01-01 00:05 via modem number 2.

  • Page 26: Email To Sms Poller

    SMS message to +48333444555 mobile number. SEND TO USERNAME/GROUP If you want to send SMS to a contact or group from SMSEagle phonebook, put the contact/group name in SUBJECT field. Notice: Messages that are processed by Email2SMS Poller (but not deleted) are marked in the mailbox as read.
  • Page 27 PLUGIN CONFIGURATION Screenshot from Email to SMS Poller  if you want to use the plugin, set ‘Enable Email2sms Poller’ to ‘Yes’  Set email 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.

  • Page 28: Sms To Email Plugin

    SMS to email of last sender (so called Two-way Email2SMS & SMS2Email) In this mode, when SMSEagle receives incoming SMS, it checks if earlier anyone was sending SMS to the number from incoming SMS using Emai2SMS. If last sender is found, the incoming SMS is forwarded to the email address of last sender.

  • Page 29: 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 request to a defined URL. HTTP request can be of type GET or POST.
  • Page 30 After sending HTTP 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.

  • Page 31: Sms Forward

    SMS Forward The plugin “SMS forward” allows to forward incoming SMS messages to one/may recipients according to defined rules. PLUGIN CONFIGURATION Plugin “SMS Forward” allows to add many forwarding rules. Each rule can be enabled or disabled by user. Screenshot from plugin main window For each rule user can define: ...

  • Page 32: Periodic Sms

    Periodic SMS The plugin “Periodic SMS” allows to send SMS messages or USSD codes at a desired time interval. User may define many sending rules, and each rule will be processed independently. PLUGIN CONFIGURATION Plugin “Periodic SMS” allows to add many sending rules. Each rule can be enabled or disabled by user. Screenshot from plugin main window For each rule the user can define: ...

  • Page 33: Digital Input/Output

    OPEN CIRCUIT PLUGIN CONFIGURATION The plugin “Digital input/output” allows you to define rules that control the behaviour of digital inputs/outputs on SMSEagle device. User may define several processing rules for both inputs and outputs. Screenshot from plugin window DIGITAL INPUTS...
  • Page 34  The rule name  Port number (1…7)  State of input signal that will trigger sending of SMS message (field “When input signal”)  SMS text (field “Send SMS message”)  The recipients from phonebook (field “Send to”) Screenshot from digital input “Add or edit rule” window DIGITAL OUTPUTS For each processing rule for digital output user can define: ...
  • Page 35 Screenshot from digital output “Add or edit rule” window Page...

  • Page 36: 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 37: Send Sms: Jsonrpc Method

    EXAMPLES: https://url-of-smseagle/index.php/http_api/send_sms? login=john&pass=doe&to=1234567&message=mymessage https://url-of-smseagle/index.php/http_api/send_sms? login=john&pass=doe&to=1234567&message=mymessage&date=201401152132 https://url-of-smseagle/index.php/http_api/send_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 Response (when wrong parameters): Wrong parameters RESPONSE (XML): Response: <xml> <message_id>[ID of message in outbox]</message_id>...
  • Page 38 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 39: 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 40: 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 41: Send Sms To Contact: Http Get Method

    HTTP GET METHOD: https://url-of-smseagle/index.php/http_api/send_tocontact Parameter Description login your user to login to 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 Page...
  • Page 42 (optional parameter) 0 = normal SMS (default), 1 = SMS will be sent as flash message modem_no (optional parameter) sending modem number (only for 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/send_tocontact? login=john&pass=doe&contactname=johndoe&message=mymessage https://url-of-smseagle/index.php/http_api/send_tocontact? login=john&pass=doe&contactname=johndoe&message=mymessage&date=20140115 2132 https://url-of-smseagle/index.php/http_api/send_tocontact? login=john&pass=doe&contactname=johndoe&message=mymessage&highpriority= RESPONSE: Response: OK;...

  • Page 43: 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 44: Send Ussd Code: Http Get Method

    {"result": [{"error_text":"Invalid contact name – contact_name]","status":"error"}]} Response (when wrong parameters): {"result": {"error_text":"Wrong parameters","status":"error"}} 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 Page...

  • Page 45: Send Ussd Code: Jsonrpc Method

    (optional parameter) sending modem number (only for 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/send_ussd? login=john&pass=doe&to=*101%23 RESPONSE: Response: OK; ID=[ID of message in outbox] Sample response: OK; ID=297...

  • Page 46: Send Binary Sms: Http Get Method

    HTTP POST METHOD: https://url-of-smseagle/index.php/jsonrpc/sms PARAMETERS: Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle USSD code modem_no (optional parameter) sending modem number (only for multimodem devices) responsetype (optional parameter) text = format response as text (default), xml = format...
  • Page 47 (optional parameter) sending modem number (only for 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/send_binary_sms? login=john&pass=doe&to=1234567&udh=0605040B8423F0&data=EA0601AE02056A00 45C60C037777772E736D736561676C652E657500080103534D534561676C65000101 RESPONSE: Response: OK; ID=[ID of message in outbox] Sample response: OK; ID=297 Response (when wrong logindata): Invalid login or password Response (when wrong parameters): Wrong or missing >>udh<<...

  • Page 48: 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 49: Read Sms: Http Get Method

    "status":"error"}} 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 from...
  • Page 50 Show messages from sentitems folder with receiver phone number 7654321 and datetime from 2014-12-24 08:10:00 to 2014-12-31 23:59:59: https://url-of-smseagle/index.php/http_api/read_sms? login=john&pass=doe&folder=sentitems&to=7654321&datefrom=20141224081000 &dateto=20141231235959 RESPONSE: Sample responses: inbox folder, sentitems folder Response (when no data): No data to display Response (when wrong logindata): Invalid login or password...

  • Page 51: Read Sms: Jsonrpc Method

    </xml> 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 from...
  • Page 52 EXAMPLES: Show all messages from inbox: {"method":"sms.read_sms", "params":{"login":"john","pass":"doe","folder":"inbox"}} Show all unread messages from inbox: {"method":"sms.read_sms", "params":{"login":"john","pass":"doe","folder":"inbox","unread":"1"}} Show messages from sentitems folder with id=1234 and higher. Limit number of messages to 5: {"method":"sms.read_sms", "params":{"login":"john","pass":"doe","folder":"sentitems","idfrom":"12 34","limit":"5"}} Show messages from inbox folder with sender phone number +481234567: {"method":"sms.read_sms", "params":{"login":"john","pass":"doe","folder":"inbox","from":"...
  • Page 53 "UpdatedInDB": "2016-11-14 10:15:58", "ReceivingDateTime": "2016-06-16 14:27:10", "Text": "004F0064007000200031", "SenderNumber": "+48987654321", "Coding": "Default_No_Compression", "UDH": "", "SMSCNumber": "+48790998250", "Class": "-1", "TextDecoded": "Odp 1", "ID": "23", "RecipientID": "smseagle1", "Processed": "t", "id_folder": "1", "readed": "true", "last_reply": "Tester", "oid": "234234" "UpdatedInDB": "2016-11-14 10:15:58", "ReceivingDateTime": "2016-06-16 14:47:10", "Text": "004F00640070002000320020", "SenderNumber": "1234", "Coding": "8bit",...
  • Page 54 "UpdatedInDB": "2014-12-05 11:58:03", "InsertIntoDB": "2014-12-05 10:57:38", "SendingDateTime": "2016-06-16 14:27:49", "DeliveryDateTime": null, "Text": "0074006500730074", "DestinationNumber": "123456789", "Coding": "Default_No_Compression", "UDH": "", "SMSCNumber": "+48602951111", "Class": "1", "TextDecoded": "test", "ID": "61", "SenderID": "smseagle1", "SequencePosition": "1", "Status": "SendingError", "StatusError": "-1", "TPMR": "-1", "RelativeValidity": "255", "CreatorID": "admin", "id_folder": "3"}, "UpdatedInDB": "2016-06-16 14:48:56", "InsertIntoDB": "2016-06-16 12:48:45",...

  • Page 55: Delete Sms: Http Get Method

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

  • Page 56: 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 57: 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 58: 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",...

  • Page 59: Get Inbox Length: Jsonrpc Method

    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? login=john&pass=doe RESPONSE: Response: [number of messages in database Inbox folder]...

  • Page 60: Get Sentitems Length: Http Get Method

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

  • Page 61: 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 62: Get Gsm/3G Signal Strength: Http Get Method

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

  • Page 63: 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 64: Phonebook Group Create: Http Get Method

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

  • Page 65: Phonebook Group Create: Jsonrpc Method

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

  • Page 66: Phonebook Group Read: Http Get Method

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

  • Page 67: 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 68: 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 69: 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 login your user to login to SMSEagle Page...

  • Page 70: Phonebook Group Delete: Http Get Method

    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 71 (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? login=john&pass=doe&group_id=2&groupname=myusers RESPONSE: Response: OK Response (when wrong logindata): Invalid login or password Response (when wrong parameters): Wrong or missing >>groupname<<...

  • Page 72: Phonebook Group Delete: Jsonrpc Method

    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 73: 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 74: 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 75: 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 76: 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 77: 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 78: 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 79: 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 80 EXAMPLES: https://url-of-smseagle/index.php/http_api/contact_read? login=john&pass=doe&public=1&uid=12 RESPONSE: Sample response: link Response (when no data): No data to display 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>...

  • Page 81: 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 82: 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 83 EXAMPLES: https://url-of-smseagle/index.php/http_api/contact_update? login=john&pass=doe&contact_id=4&contactname=johnlord&number=123456789& public=1 RESPONSE: Response: OK Response (when wrong logindata): Invalid login or password Response (when wrong parameters): Wrong or missing >>contactname<< parameter Wrong or missing >>contact_id<< parameter Wrong or missing >>number<< parameter Response (when contact_id is wrong): Contact with the given id does not exists...

  • Page 84: Phonebook Contact Update: Jsonrpc Method

    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 85: Phonebook Contact Delete: Http Get Method

    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 (optional parameter) text = format response as text (default), xml = format...

  • Page 86: 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 87 {"result": {"error_text":"Wrong or missing >>contact_id<< parameter","status":"error"}} Response (when contact_id is wrong): {"result": {"error_text":"Contact with the given id and name does not exists","status":"error"}} Page...

  • Page 88: 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 89: Connecting Directly To Smseagle Database

    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 SMSEagle Database name: smseagle User: smseagleuser...

  • Page 90: Injecting Long Sms Using Sql

    Injecting long SMS using SQL Inserting multipart messages is a bit more tricky, you need to construct also UDH header and store it hexadecimally written into UDH field. Unless you have a good reason to do this manually, use API. For long text message, the UDH starts with 050003 followed by byte as a message reference (you can put any hex value there, but it should be different for each message, D3 in following example), byte for number of messages (02 in example, it should be unique for each message you send to same phone...
  • Page 91 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. Page...

  • Page 92: Database Cleaning Scripts

    Database cleaning scripts We have added some useful scripts which may be used to delete SMS messages from database through Linux CLI. Scripts are located at following directory: /mnt/nand-user/scripts/  db_delete – script for deleting SMS from folders Inbox, SentItems older than provided date. Usage: ./db_delete YYYYMMDDhhmm ...

  • Page 93: Snmp Agent

    IP networks. 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 94 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: http://www.smseagle.eu/download/NET-SNMP-EXTEND-MIB.txt READING RESULT VALUES 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).
  • Page 95 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 96: 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 97: Forwarding Logs To External Server

    Forwarding logs to external server Our devices runs rsyslog for log managing. Here we describe how to configure additional rules for rsyslog daemon: rsyslogd. This is only a brief excerpt from rsyslog manual website. Full information is available at: http://www.rsyslog.com/ Rsyslogd configuration is managed using a configuration file located at /etc/rsyslog.conf ...

  • Page 98: Automatic Software Updates Checks

    Automatic software updates checks SMSEagle software is under process of continual improvement. We listen to our customers, and new releases are based on our customer’s inputs/requests. Software updates are released frequently, and offer access to new features and fixes to reported issues. Web-GUI offers you a possibility to automatically check for new software updates.

  • Page 99: Troubleshooting

    3. TROUBLESHOOTING Page...

  • Page 100: Verification Of Leds

    Not used Checking the device logs SMSEagle operates on Linux system. Linux system log is available under menu position “Settings” > “Logs”. In case of any problems with the device this log is a valuable source of troubleshooting information. Please attach information from this log when contacting with SMSEagle Support Team.

  • Page 101: Restoring Factory Defaults

    Restoring factory defaults This action restores the following settings to default values: IP settings, database content. In order to restore factory defaults proceed with the following steps: LED signaling USER actions System reaction When the device is ready to operate: When READY LED is blinking and USER LED is disabled (do not...

  • Page 102: Service And Repair

    4. SERVICE AND REPAIR Page...

  • Page 103: Warranty

    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 104: Tech Specs And Safety Information

    5. TECH SPECS AND SAFETY INFORMATION Page...

  • Page 105: Technical Specifications

    Technical Specifications Hardware Specification  Processor type: ARM9 32bit 200MIPS RISC  Network interface: Ethernet 10/100 TX (1xRJ45)  1GB Flashdisk  RTC Clock: RTC 240B SRAM, Watchdog timer  Power consumption: max 17W  Noise level: Fanless  Dimensions: (width x depth x height) 35 x 120 x 101 mm ...
  • Page 106  Outgoing transmission rate: up to 20 SMS/min  API send SMS requests: 30 SMS/min (messages are queued for sending in a built-in database) Software Platform  Operating system: Linux 2.6  built-in Apache2 web server  built-in PostgreSQL database server ...

  • Page 107: Important Safety Information

    Important Safety Information This chapter provides important information about safety procedures. For your safety and that of your equipment, follow these rules for handling your device. WARNING: Incorrect storage or use of your device may void the manufacturer’s warranty. Failure to follow these safety instructions could result in fire, electric shock, or other injury or damage.

This manual is also suitable for:

Nxs-9750

Table of Contents