SMSEagle MHD-8100-3G, User Manual

Page 1: ...SMSEAGLE MHD 8100 3G MHD 8100 4G User s Manual ...

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

Page 3: ...and using placeholders 27 Folders 28 MMS 28 Purge folders automatic message cleanup 29 Phonebook 30 Phonebook Contacts 30 Phonebook Groups 31 Phonebook Escalation Groups 32 Phonebook Working Shifts 33 Users 33 Multi User Capabilities 34 Reporting Module 35 Statistics view 35 Multi Factor Authentication 36 Settings 38 Application Settings 38 IP Settings 40 Failover 41 Date Time 41 Maintenance 41 Em...

Page 4: ... Forward 67 Callback URL plugin 68 Periodic SMS 70 Autoreply plugin 71 LDAP plugin 73 Blacklist 75 Multimodem features 77 SMSEagle API 78 0 API Authentication 78 1 Send SMS HTTP GET method 78 2 Send SMS MMS JSONRPC method 81 3 Send SMS to a group HTTP GET method 83 4 Send SMS MMS to a group JSONRPC method 85 5 Send SMS to contact HTTP GET method 87 6 Send SMS MMS to contact JSONRPC method 89 7 Sen...

Page 5: ...hod 128 23 Phonebook group create HTTP GET method 129 24 Phonebook group create JSONRPC method 130 25 Phonebook group read HTTP GET method 131 26 Phonebook group read JSONRPC method 133 27 Phonebook group update HTTP GET method 134 28 Phonebook group update JSONRPC method 136 29 Phonebook group delete HTTP GET method 137 30 Phonebook group delete JSONRPC method 138 31 Phonebook group add contact H...

Page 6: ... 52 Phonebook shift delete JSONRPC method 169 53 Phonebook shift add contact HTTP GET method 170 54 Phonebook shift add contact JSONRPC method 172 55 Phonebook shift remove contact HTTP GET method 173 56 Phonebook shift remove contact JSONRPC method 174 57 Get modem state HTTP GET method 175 58 Get modem state JSONRPC method 177 59 Set modem state HTTP GET method 178 60 Set modem state JSONRPC met...

Page 7: ...ver 204 Automatic software updates check 205 Knowledgebase Support Portal 206 Troubleshooting 208 Verification of LEDs 208 Checking the device information 208 Device logs 208 When the device is not reachable 208 Restoring factory defaults 209 Service Repair 211 Warranty 211 Service 211 Tech Specs Safety Information 213 Technical Specification 213 Important Safety Information 216 Regulatory Stateme...

Page 8: ...entation d Industrie Canada 219 UK Declaration of Conformity 219 RF Exposure Limits 219 Disposal and Recycling Information 219 Information gemäß 4 Absatz 4 Elektrogesetz DE 220 Restriction of Hazardous Substances Directive RoHS 220 ...

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

Page 10: ... DO NOT 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 ABOVE THE SMSEAGLE SOFTWARE IS PROTECTED BY COPYRIGHT LAWS AS WELL AS ANY OTHER RELEVANT INTELLECTUAL PROPERTY LAWS THE SMSEAGLE SOFTWARE IS LICENSED AND NOT SOLD ALL RIGHTS INCLUDING COPYRIGHTS ...

Page 11: ... 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 purposes of this Agreement to the extent that it would impose any new or extended obligation liability or restriction on or otherwise adversely affect the rights of any Party 1 10 A reference to writing or w...

Page 12: ...le 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 source code e Attempt to alter or remove any trademark copyright or other proprietary notice contained within the SMSEagle Software or f Make use of SMSEagle Software in any manner not stipulated wi...

Page 13: ...TIVE AND 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 FAIL OF ITS ESSENTIAL PURPOSE 6 OPEN SOURCE Certain software modules in the PROXIMUS Software are subject to open source or free software licenses Open Source Software Some of the Open Sourc...

Page 14: ...NG LAW In matters not regulated herein the provisions of the Polish Civil Code shall apply and provisions 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 disputes arising from the present Agreement and or in connection with it shall be finally decided with...

Page 15: ...nsumer protections and entrepreneur protection if You are a natural person who buys the device and conclude 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 EULA concluded from January 1st 2021 If any provision of this EULA is inconsistent with mandatory...

Page 16: ...16 SMSEagle MHD 8100 User s Manual WHAT S IN THE BOX Your SMSEagle box contains SMSEagle hardware SMS gateway 8x External omnidirectional antenna AC Power cable Rack mounting brackets Quick start guide ...

Page 17: ...t 23 cm 9 inches from all persons and must not be co located or operating in conjunction with antenna from any other transmitter Antennas must not be installed inside metal cases Screw antennas to the antenna connector on the back of the enclosure of SMSEagle device STEP 2 Insert SIM Card Please install SIM Card when the device is SWITCHED OFF SIM Card slots is located on the front panel of the de...

Page 18: ...cables are not provided login to the terminal window using root credentials these were provided with your device edit configuration file with command nano opt smseagle syscfg change the following lines ETH1_HOST_IP set IP address for your device ETH1_GW_IP default gateway IP address ETH1_NET_MASK set subnet mask ETH1_START_DHCP Y set to ETH1_START_DHCP N to disable DHCP client save and exit the fi...

Page 19: ...d to your gateway SMSEAGLE DEFAULT USER Login to application with above username and password PREPARE FOR FIRST START D CONFIGURE STATIC IP SETTINGS IN WEB GUI OPTIONAL Click on menu position Settings and navigate to tab IP Settings Disable DHCP server Enter your IP settings Press Save button Username admin Password password ...

Page 20: ...ice 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 free Let s Encrypt SSL certificate Using HTTPS only By default SMSEagle webGUI can be accessed via HTTP or HTTPS For improved security we recommend using HTTPS If you would like to redirect HTTP HTTPS follow instructions in t...

Page 21: ...21 SMSEagle MHD 8100 User s Manual USING OF SMSEAGLE II ...

Page 22: ...the device Display Display screen User Switch SW Switch to toggle information on the display restore settings to factory defaults Status LED STATUS LED indicating device status SIM slot 8x SIM slot mini size SIM Active LED ACTIVE 8x LED indicator for modem status Antenna ANT1 8 Antenna socket SMA Reset RESET Switch for rebooting the device USB USB 2x USB 3 0 port ...

Page 23: ...y has 5 screens with different information on each scree Using SW switch you can change screens of the display Screen 1 SMSEagle Logo Screen 2 System Usage 1 Device power on time 2 CPU usage in 3 CPU temperature in Celsius 4 RAM usage in Mb and Screen 3 Networking IP list Screen 4 Dashboard Statistics list of messages in 1 Inbox 2 Outbox 3 Sentitems 4 Sent Errors Screen 5 Modem signal strength lis...

Page 24: ...hones etc Open a web browser on your device type in SMSEagle s IP address as set in previous chapter At login screen type in your username password Default username and password is given in chapter Prepare for First Start Important Notice The Web GUI requires a modern web browser with JavaScript support Older web browsers like Internet Explorer are not supported and may not work properly ...

Page 25: ...cely grouped by phone number You can easily track history of what you send and receive Sending to single numbers contacts or groups from phonebook Import messages for sending from CSV file SMS Scheduling by specified date and time or delay SMS sending within specified time window between selected hours Message templates save edit your own templates Unicode support support of national characters Mu...

Page 26: ...sending the placeholder will be replaced by a unique value for each imported row from CSV file This allows you to send a personalized message to each recipient Set send date to now at a date and time after a delay between selected hours or with high priority Set duration validity of SMS Type of SMS normal flash MMS WAP Push Link or USSD Code Set a message template to be saved and used at another t...

Page 27: ...aced with unique values for each message First a csv file is needed like in the example below Columns can be added and named as needed When composing an SMS using csv file as a source each column in the uploaded csv file becomes a placeholder that will fill in the information from your file Placeholders can be added to the message body by clicking the column name in the Select field as seen below ...

Page 28: ...nbox Outbox Sent Items Spam Trash The view of conversations can be either of type Balloons smartphone like conversation or Table tabular view The view type can be changed in menu Settings Application Balloons view type Table view type MMS To view an MMS attachment you need to click show MMS attachment in the inbox message ...

Page 29: ...cleanup This function allows you to add rules on when to automatically purge clean up 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 ...

Page 30: ...cts 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 Phonebook Contacts Below we present a main Phonebook view where user manages his Contacts Screenshot of default phonebook view In Phonebook Contact Management users can Add edit delete contacts via web gui Import contacts from CSV...

Page 31: ...ose if contact is Private Public Assign a selected modem to the contact or leave default modem choice according to global settings 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 Phonebook Group Management view users can ...

Page 32: ...ho created the contact group Private contacts groups are visible to a 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 escalated to the group members The message will be escalated with given time interval until a set STOP word is received Screenshot fro...

Page 33: ... 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 you to manage access to your device It allows you to add edit and remove users and set their permissions There are two access levels for a user User role Administrator Allows full access control of t...

Page 34: ...users with different access levels Administrator or User Those users may access the device simultaneously via Web GUI or API The following set of features is available in multi user work scenario Multiple users may acess the device simultaneously via webGUI or API Each user can create private or public shared Phonebook contacts and groups see details in Phonebook chapter ...

Page 35: ...everybody only for Administrator role only for modems assigned to a user see details in Application settings chapter Reporting Module Reporting module is an extension of basic search feature The module allows users to filter messages from Inbox Sent items folders based on custom criteria and display filtered messages Filtered list of messages can be exported to PDF or CSV file Screenshot of Report...

Page 36: ... provide a username and a password plus additional identity verification such as a code received via SMS text ENABLE MFA FROM USER SETTINGS MFA can be enabled by each user 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 entered in User Settings MFA c...

Page 37: ...S token every time he logs in to Web GUI One time SMS token is valid for 10 minutes Screenshot from login process with enabled MFA RECOVERY CODE If for some reason a user can t receive a text message or don t have access to his phone a recovery 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 rec...

Page 38: ... MFA BY ADMINISTRATOR MFA can also be enabled by an administrator role for selected users This is done in the menu Users Edit User 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 Tab Application ...

Page 39: ...leted or be moved to Trash 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 Only admins or Only from assigned modems You can set access of the reporting module to All users or Only admins You can set a delay between SMS sending in seconds this setting may be useful for cases where cellular ...

Page 40: ... Settings tab IP Settings You can enable or disable Get IP address from DHCP You can input the IP address You can input the Subnet Mast 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 ...

Page 41: ...the Settings Tab Date Time You can check current device date and time You can set your time zone You 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 NTP timeserver address Maintenance Maintenance settings can be accessed under the Settings tab Mainten...

Page 42: ...put your SIM card PUK Multimodem settings are described in chapter Multimodem features Email Alerts Email Alerts feature allows to send email alert message to a selected email address once SMS sending errors occurs When a defined error counter threshold is reached alert email is triggered The feature can be accessed under Settings tab Email Alerts ...

Page 43: ... 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 information in system log enable this only for troubleshooting Notice To prevent false alarms we recommend to set parameter Send alert when error counter exceeds to value 2 ...

Page 44: ...ser s Manual Call Forward Call forward settings can be accessed under the Settings tab Call forward You can choose to forward all incoming calls to a chosen number MMS MMS Settings can be accessed under the Settings tab MMS ...

Page 45: ...ard 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 SMSEagle as a backup Internet source Data connection is NOT REQUIRED for normal operation of SMSEagle device Leave it disabled OFF if you don t want to use it You can choose to autorestart data conn...

Page 46: ... name custom value SNMP deamon is required only when you want to monitor your device from external monitoring solutions like Network Monitoring Systems etc You can read more about custom SNMP metrics available on SMSEagle device in SNMP agent chapter SSL Certificate and HTTPS Redirection SSL settings can be accessed under the Settings tab SSL The settings allows you to upload an SSL certificate to...

Page 47: ...e recommend using HTTPS only connections with your SMSEagle You may easily forward HTTP to HTTPS traffic by setting Forward HTTP to HTTPS to Yes Generate CSR This feature simplifies a process of obtaining SSL certificate It creates two files CSR file Certificate Signing Request It is needed in a SSL certification procedure It is a file containing an encrypted text generated by the server on which ...

Page 48: ... interval daily weekly monthly and time o You can select how many backups to keep delete backups You can restore device settings form a previously saved file You can choose to additionally restore the database WARNING Restore backup settings only works with the same version of device and software SNMP SNMP Settings can be accessed under the Settings tab SNMP ...

Page 49: ... Click on the button Check for software update now At the top pops up a balloon in 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 Updates and check the option Automatically check for software updates This will enable periodic checks once a month for available software updates If a new update is available a me...

Page 50: ...50 SMSEagle MHD 8100 User s Manual Screenshot from General Settings Updates Notice Your SMSEagle device must have a HTTPS connectivity with address updates smseagle eu in order for this feature to work ...

Page 51: ...ystem 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 feature allows you to assure high availability of SMSEagle devices in critical environments To enable failover HA cluster you need 2 devices aka nodes The failover feature monitors devices working in th...

Page 52: ...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 CLUSTER Failover cluster can be easily configured using Web GUI Configuration can be done in menu Settings tab Failover The configuration should be exactly the same on both devices in HA cluster Please c...

Page 53: ...this 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 cluster Failover feature uses KEEPALIVED MIB for SNMP monitoring EXAMPLE OF READING DEVICE CLUSTER STATE VALUE USING NET SNMP LIBRARY a Command for reading the result value snmpget v 2c c public ip of s...

Page 54: ... 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 defined SMS alert when host service is unavailable goes back to life or when SNMP return value reaches required criteria Below you will find a brief overview of plugin capabilities Control status of al...

Page 55: ...le 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 test the connection of server Define a schedule choose if task should be always enabled or disable it at chosen times during a night when a machine goes through planned restarts during resource intensiv...

Page 56: ...NSE 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 chance to react quickly MONITORING FREQUENCY Monitoring tasks are performed in a parallel mode Software automatically optimizes number of parallel tasks and frequency of tasks taking into account the ...

Page 57: ...rformance 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 popular mechanism used to manage and monitor devices activities via SNMP protocol What makes the Trap unique is that they are triggered instantaneously by an agent rather than waiting for a ...

Page 58: ...address 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 email is the text of the SMS message optionally you can append email subject at the beginning of SMS message Example email message sent to the address 123456789 192 168 0 101 will be converted to SMS me...

Page 59: ...dap admins1 group The myldap admins1 group must be defined in your LDAP directory and LDAP plugin must be configured on your SMSEagle device 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 d...

Page 60: ...add many forwarding rules Each rule can be enabled or disabled by user Screenshot from Email To SMS Rules window Screenshot from Email to SMS Add new rule You can name your rule You can set forwarding to Always or For specified senders when email contains You can choose sending modem no ...

Page 61: ...il 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 to the value Maximum number of characters Maximum allowed length of SMS message is 1300 characters if you want to include in SMS message special national characters like ąäàöß 我 set Unicode encoding of SM...

Page 62: ...eagle 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 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 ...

Page 63: ...agle MHD 8100 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 You can choose sending modem no ...

Page 64: ...lude 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 emails from the mailbox after they are fetched by Email2SMS Poller please mark Delete emails from server after processing If you want to send as MMS select always or only when email contains an attachm...

Page 65: ...f 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 this mode incoming SMS messages are forwarded to always the same email address Plugin uses an external SMTP server for sending emails PLUGIN CONFIGURATION Plugin SMS To Email allows to add many forw...

Page 66: ... 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 phonebook contact name if found Date time when SMS is received SMS message Example email text sent from plugin From 483334455 John Doe Received 2017 06 01 14 38 12 Message My SMS message ...

Page 67: ...indow 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 which original SMS came from When defining a rule user can choose SMS recipient who gets the forwarded SMS It can be either phone number or name of group from phonebook User may define many forwardi...

Page 68: ... forward incoming SMS message to a defined URL address If the plugin is enabled on each incoming SMS message SMSEagle will trigger HTTP S request to a defined URL HTTP S request can be of type GET or POST PLUGIN CONFIGURATION Plugin Callback URL allows to add unlimited number of rules Each rule can be enabled or disabled by user ...

Page 69: ...se whether callback to your URL is done with HTTP S GET or POST method When message comes to allows to choose a particular modem or all modems Send request when defines if 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 value This will be passed to...

Page 70: ...rom your callback URL SMSEagle will keep retrying every X minute for 24 hours Retry interval can be set in main plugin Window 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...

Page 71: ...rule the user can define The rule name Sending interval Hourly Daily Weekly Monthly or Annually Message type SMS USSD Code The content of the SMS text The recipients phone number s separated with comma or group s from phonebook Screenshot from Add new rule window Autoreply plugin ...

Page 72: ...m plugin main window For each rule user can define When autoreply message should be sent o always o when incoming message contains defined text o and or when message sender belongs to Phonebook contact group o if incoming SMS text comes to a selected modem If autoreply message text should be sent as Unicode characters Plugin also allows to define sending limit for autoreply messages It is possible...

Page 73: ...Eagle web GUI The plugin can work with either Active Directory or OpenLDAP protocol type PLUGIN CONFIGURATION Choose LDAP from left side menu in SMSEagle web GUI to access plugin configuration After enabling the plugin user needs to fill in all requested fields according to AD settings In the AD phone attribute field user needs to choose which phone attribute from AD will be shown in SMSEagle web ...

Page 74: ... 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 of contact group name or number to show AD contact suggestions Type LDAP case sensitive to check all contacts listed in AD directory ...

Page 75: ...y suggestions can be used in Compose and Autoreply features Blacklist This feature allows you to add a number to a Blacklist When a number is on this list the device automatically blocks any sent and received SMS from the number as well as deletes the messages from your inbox Screenshot from Blacklist feature ...

Page 76: ...76 SMSEagle MHD 8100 User s Manual Screenshot from Blacklist Define STOP word feature ...

Page 77: ...SMS messages This means that device sends messages using modem1 modem2 modem3 modem4 etc SIMX as Master modem In this strategy modemX is always selected when sending out SMS messages If failover is enabled see below other modems will be always used as a backup in failover strategy Enable modem failover mechanism If this setting is enabled when one modem stops working other will automatically take ...

Page 78: ...e 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 API User credentials to authenticate in API methods EXAMPLES OF AUTHENTICATION with access token https url of smseagle http_api send_sms access_token 0001gOjCOlMH8F2q with login and password https url o...

Page 79: ...oming 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 multimodem devices responsetype optional parameter text format response as text default xml format response as XML object validity optional parameter How long will be the message valid If message expires before it is rec...

Page 80: ...ESPONSE XML Response xml message_id ID of message in outbox message_id status ok status xml Sample response xml message_id 297 message_id status ok status xml Response when wrong logindata xml error_text Invalid login or password error_text status error status xml Response when wrong access token xml error_text Invalid Access token error_text status error status xml Response when wrong parameters ...

Page 81: ...er 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 allows client applications to match incoming reply messages to outgoing messages If no oid was assigned to the outgoing message this attribute will have a value of null for incoming message The oid v...

Page 82: ...hod 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 method sms send_sms params access_token 0005gOjCOlMH8F2x to 481234567 message My message highpriority 1 SAMPLE BODY MMS method sms send_sms params access_token 0005gOjCOlMH8F2x to 481234567 message My ...

Page 83: ...in 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 priority 1 SMS will have higher priority in Outbox queue when processed by GSM modem unicode optional parameter 0 no Unicode encoding default 1 SMS will be encoded using Unicode you can send national c...

Page 84: ...ccess_token 0005gOjCOlMH8F2x groupname admins message mymessage date 20140 1152132 https url of smseagle http_api send_togroup access_token 0005gOjCOlMH8F2x groupname admins message mymessage highpriori ty 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 access token Invalid access token Response...

Page 85: ... 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 priority in Outbox queue when processed by GSM modem unicode optional parameter 0 no Unicode encoding default 1 SMS will be encoded using Unicode you can send national characters flash optional parameter ...

Page 86: ...meter 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 admins message mymessage or method sms send_togroup params access_token 0005gOjCOlMH8F2x groupname admins message mymessage date 201401152132 or method sms send_togroup params access_token 0005gOjCOlMH8F2...

Page 87: ...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 have higher priority in Outbox queue when processed by GSM modem unicode optional parameter 0 no Unicode encoding default 1 SMS will be encoded using Unicode you can send national characters flash optional par...

Page 88: ...actname 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 OK ID ID of message in outbox Sample response OK ID 297 Response when wrong logindata Invalid login or password Response when wrong access token Invalid access token Response when contact doesn t exi...

Page 89: ...ails 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 optional parameter date and time in 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 highprio...

Page 90: ...al 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 Supported mime types image jpeg image gif image png image bmp content file content with data encoded in base64 test optional parameter 1 simulate message sending Messages with that parameter will not be add...

Page 91: ...token 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 Send USSD code HTTP GET method HTTP GET METHOD https url of smseagle http_api send_ussd Parameters Parameter Description access_token authentication access token see details in point API Authenticati...

Page 92: ...e in outbox message_id status ok status xml Sample response xml message_id 297 message_id status ok status xml Response when wrong logindata xml error_text Invalid login or password error_text status error status xml Response when wrong access token xml error_text Invalid Access token error_text status error status xml Response when wrong parameters xml error_text Wrong parameters error_text statu...

Page 93: ...d 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 Response when wrong access token result Invalid access token Response when wrong parameters result Wrong parameters RESPONSE EXTENDED Response result message_id ID of message in outbox status ok Sample r...

Page 94: ...pe 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 and they will return ID 0 EXAMPLES https url of smseagle http_api send_binary_sms access_token 0005gOjCOlMH8F2x to 1234567 udh 0605040B8423F0 data EA0601AE02 056A0045C60C037777772E736D736561676C652E6...

Page 95: ...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 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 Authentication pass your password t...

Page 96: ...esponse 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 missing udh parameter Response when wrong parameters result Wrong or missing data parameter RESPONSE EXTENDED Response result message_id ID of message in outbox status ok Sample response result message_id...

Page 97: ...meter 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 optional parameter username or email if message was sent via Email to SMS of sending user modem_no optional parameter sending modem number only for multimodem devices EXAMPLES Show all messages from in...

Page 98: ...lass 1 Class TextDecoded Test 1 TextDecoded ID 124 ID RecipientID smseagle1 RecipientID Processed t Processed id_folder 1 id_folder readed true readed oid oid Status 0 Status item item UpdatedInDB 2018 07 17 15 11 31 UpdatedInDB ReceivingDateTime 2018 07 17 15 04 10 ReceivingDateTime Text 005400650073007400200032 Text SenderNumber 48123456788 SenderNumber Coding Default_No_Compression Coding UDH U...

Page 99: ...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_folder 1 id_folder readed true readed oid oid Status 0 Status item messages status ok status xml Sample response sentitems folder xml messages item UpdatedInDB 2018 06 07 11 29 56 UpdatedInDB InsertIntoD...

Page 100: ...xtDecoded Test test1 TextDecoded ID 574 ID SenderID smseagle1 SenderID SequencePosition 1 SequencePosition Status DeliveryOK Status StatusError 0 StatusError TPMR 84 TPMR RelativeValidity 255 RelativeValidity CreatorID admin CreatorID id_folder 3 id_folder StatusCode 1 StatusCode item item UpdatedInDB 2018 07 18 14 27 13 UpdatedInDB InsertIntoDB 2018 07 18 14 27 03 InsertIntoDB SendingDateTime 201...

Page 101: ...D admin CreatorID id_folder 3 id_folder StatusCode 1 StatusCode item item UpdatedInDB 2018 07 18 14 29 29 UpdatedInDB InsertIntoDB 2018 07 18 14 28 46 InsertIntoDB SendingDateTime 2018 07 18 14 29 29 SendingDateTime DeliveryDateTime DeliveryDateTime Text 0054006500730074002000770069007400680020006200610064002000700068006F0 06E00650020006E0075006D006200650072 Text DestinationNumber 11 DestinationNu...

Page 102: ...text encoded using hex values SenderNumber character varying 30 SMS sender number Coding character varying 255 SMS text coding Possible values Default_No_Compression Unicode_No_Compression 8bit Default_Compression Unicode_Compression UDH text User Data Header encoded using hex values SMSCNumber character varying 20 SMSC number Class integer SMS class 0 is flash SMS 1 is normal SMS 127 is USSD Text...

Page 103: ...ge 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 it has been enabled Null if delivery report was not received Text text SMS text encoded using hex values DestinationNumber character varying 30 destination number for SMS Coding character varying 25...

Page 104: ... 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 integer The Message Reference field TP MR as defined in GSM 03 40 RelativeValidity integer SMS relative validity TP VP encoded as defined in GSM 03 40 CreatorID text username that created the SMS message...

Page 105: ... 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 message was sent via Email to SMS of sending user modem_no optional parameter sending modem number only for multimodem devices Include_attachments optional parameter add attachments for MMS messages...

Page 106: ...seagle1 Processed t id_folder 1 readed true oid 5208facc 5912 4d21 8d31 7f830cf8f24e Status 0 UpdatedInDB 2018 07 18 13 56 16 ReceivingDateTime 2018 07 17 15 05 49 Text 004C006F00720065006D00200069007000730075006D00200064006F006C006F0072002000 730069007400200061006D00650074002C00200063006F006E0073006500630074006500740 0750072002000610064006900700069007300630069006E006700200065006C00690074002E 0020...

Page 107: ...sentitems 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 48123456789 Coding Default_No_Compression UDH SMSCNumber 48501200777 Class 1 TextDecoded test ID 456 SenderID smseagle1 SequencePosition 1 Status DeliveryOK StatusError 1 TPMR 116 RelativeValidity 2...

Page 108: ... 03 SendingDateTime 2018 07 18 14 27 13 DeliveryDateTime null Text 00540065007300740020007700690074006800200075006E00690063006F00640065002000 65006E0063006F00640069006E0067003A00200105014200F30119017A0107 DestinationNumber 123456788 Coding Unicode_No_Compression UDH SMSCNumber 48601000310 Class 1 TextDecoded Test with unicode encoding ąłóęźć ID 576 SenderID smseagle1 SequencePosition 1 Status Send...

Page 109: ...Number 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 RelativeValidity 255 CreatorID admin id_folder 3 StatusCode 21 Sample response with include_attachments parameter result UpdatedInDB 2020 12 18 16 52 32 InsertIntoDB 2020 12 18 16 52 16 SendingDateTime 2020 12 18...

Page 110: ...ponse 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 06 06 ReceivingDateTime 2018 07 17 15 04 04 Text 005400650073007400200031 SenderNumber 48123456789 Coding Default_No_Compression UDH SMSCNumber 48790998250 Class 1 TextDecoded Test 1 ID 124 Recipien...

Page 111: ...006F0072002C0020006D0061006C00650073007500610064 006100200076006100720069007500730020006C006900670075006C0061002000680065006 E006400720065 SenderNumber 48123456787 Coding Default_No_Compression UDH 050003590301 SMSCNumber 48790998250 Class 1 TextDecoded Lorem ipsum dolor sit amet consectetur adipiscing elit Cras fermentum ullamcorper egestas Nulla placerat finibus dolor malesuada varius ligula hen...

Page 112: ...0777 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 41 InsertIntoDB 2018 07 18 14 25 23 SendingDateTime 2018 07 18 14 25 28 DeliveryDateTime 2018 07 18 14 25 28 Text 0054006500730074002000740065007300740031 DestinationNumber 48123456788 Coding Default...

Page 113: ...7 18 14 27 32 SendingDateTime 2018 07 18 14 27 36 DeliveryDateTime null Text 00540065007300740020006F006600200066006C0061007300680020006D00650073007300 6100670065 DestinationNumber 123456788 Coding Default_No_Compression UDH SMSCNumber 48601000310 Class 0 TextDecoded Test of flash message ID 577 SenderID smseagle1 SequencePosition 1 Status SendingOK StatusError 1 TPMR 87 RelativeValidity 255 Creat...

Page 114: ...e null Text 0054006500730074002000740065007300740031 DestinationNumber 48601000310 Coding Unicode_No_Compression UDH SMSCNumber Class 100 TextDecoded Test test1 ID 1174 SenderID smseagle1 SequencePosition 1 Status SendingOKNoReport StatusError 1 TPMR 1 RelativeValidity 255 CreatorID admin id_folder 3 StatusCode 200 MMS_ID F9188B35A22EB175 MMSHeaders MMSReports null Attachments ContentType image jp...

Page 115: ... 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 unique identification number RecipientID text which modem received the message for example smseagle1 smseagle2 Processed boolean whether SMS was processed by SMSEagle application id_folder integer identi...

Page 116: ...estamp 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 DeliveryDateTime timestamp time of receiving a delivery report if it has been enabled Null if delivery report was not received Text text SMS text encoded using hex values DestinationNumber character varying 30 de...

Page 117: ...ivery 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 validity TP VP encoded as defined in GSM 03 40 CreatorID text username that created the SMS message id_folder integer identification of storage folder Possible values 3 Sent items 5 Trash 11 Custom ...

Page 118: ...ox 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 id 1234 from inbox https url of smseagle http_api delete_sms access_token 0005gOjCOlMH8F2x folder inbox idfrom 1234 idto 1234 Delete messages with id 1234 1250 from inbox https url of smseagle http_a...

Page 119: ...n 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 idto maximal 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...

Page 120: ...or 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 Authentication Login your user to login to SMSEagle see details in point API Authentication Pass your password to login to SMSEagle Responsetype optional parameter text format response as text default...

Page 121: ...sponse 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 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 Authentication Pass your password to lo...

Page 122: ...r 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 HTTP GET METHOD https url of smseagle http_api get_inbox_length Parameter Description access_token authentication access token see details in point API Authentication Login your user to login to SMS...

Page 123: ...ong 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 Response when wrong parameters xml error_text Wrong parameters error_text status error status xml 18 Get inbox length JSONRPC method HTTP POST METHOD https url of smseagle jsonrpc sms Parameter Description ...

Page 124: ...mber 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 wrong access token result error_text Invalid access token status error Response when wrong parameters result error_text Wrong parameters status error 19 Get sentitems length HTTP GET method HTTP GET ...

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

Page 126: ...esponse 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 access token Response when wrong parameters result Wrong parameters RESPONSE EXTENDED Response result sentitems_length number of messages in database Sentitems folder status ok Sample response result ...

Page 127: ...nal access_token 0005gOjCOlMH8F2x modem_no 1 RESPONSE Response 3G 4G signal strength in percent values between 0 100 If 3G modem is disconnected from cellular network method returns 1 Sample response 74 Response when wrong logindata Invalid login or password Response when wrong access token Invalid access token Response when wrong parameters Wrong parameters RESPONSE XML Response xml signal_streng...

Page 128: ...m_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 extended format response as extended JSON object BODY method signal get_gsmsignal params access_token 0005gOjCOlMH8F2x RESPONSE Response result 3G 4G signal strength in percent values between 0 100 If 3G 4...

Page 129: ...point 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 format response as text default xml format response as XML object EXAMPLES https url of smseagle http_api group_create access_token 0005gOjCOlMH8F2x groupname myusers public 1 RESPONSE Response OK ID ID o...

Page 130: ...eter 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 login to SMSEagle groupname name for the created group public optional parameter 0 private group 1 public group responsetype optional parameter simple format response as simple object with one result fie...

Page 131: ...https 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 point API Authentication pass your password to login to SMSEagle public optional parameter 0 private group default value 1 public group uid optional parameter id of user who created the group responsetyp...

Page 132: ...er is_public true is_public item item Name work Name ID 4 ID id_user 1 id_user is_public true is_public item groups status ok status xml Response when no data xml error_text No data to display error_text status error status 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 tok...

Page 133: ...ate 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 extended format response as extended JSON object EXAMPLES method phonebook group_read params access_token 0005gOjCOlMH8F2x public 1 uid 12 RESPONSE Sample response result Name private ID 2 id_user 1 is_p...

Page 134: ...ter 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 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 login to SMSEa...

Page 135: ...se 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 token error_text status error status xml Response when wrong parameters xml error_text Wrong or missing groupname parameter error_text status error status xml xml error_text Wrong or missing group_id par...

Page 136: ...d 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 when wrong access token result Invalid access token Response when wrong parameters result Wrong or missing groupname parameter result Wrong or missing group_id parameter Response when group_id is wro...

Page 137: ...ame 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 0005gOjCOlMH8F2x group_id 2 groupname myusers RESPONSE Response OK Response when wrong logindata Invalid login or password Response when wrong access token Invalid access token Response when wrong parameters W...

Page 138: ...xml 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 login your user to login to SMSEagle see details in point API Authentication pass your password to login to SMSEagle group_id id of existing group groupname name of existing group responsetype optional...

Page 139: ...arameter 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 Phonebook group add contact HTTP GET method HTTP GET METHOD https url of smseagle http_api group_addcontact Parameter Description access_token authentication access token see details in point API Authentic...

Page 140: ...s 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_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 xml error_text Wrong or ...

Page 141: ...onsetype 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 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 token result Invalid access tok...

Page 142: ...cess_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_id id of existing group or id s separated with comma contact_id id of contact The contact will be removed from the group responsetype optional parameter text format response as text default xml form...

Page 143: ...cess 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 xml error_text Wrong or missing contact_id parameter error_text status error status xml Response when id is wrong xml error_text Group with the given id does not exists error_text status error status x...

Page 144: ...ok 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 token result Invalid access token Response when wrong parameters result Wrong or missing group_id parameter result Wrong or missing contact_id parameter Response when id is wrong result Group with t...

Page 145: ...r 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 text default xml format response as XML object EXAMPLES https url of smseagle http_api contact_create access_token 0005gOjCOlMH8F2x contactname johndoe number 12345678 public 1 RESPONSE Response OK I...

Page 146: ...arameter 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 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 contactname name for the created contact n...

Page 147: ...atus 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 parameters result error_text Wrong or missing contactname parameter status error result error_text Wrong or missing number parameter status error 37 Phonebook contact read HTTP GET method HTTP GET MET...

Page 148: ...ssword 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 item ID 2 ID GroupID 1 GroupID Name John Doe Name Number 123123123 Number id_user 1 id_user is_public true is_public item item ID 4 ID GroupID 1 GroupID Name Jan Nowak Name Number 4215456456 Number id_...

Page 149: ... 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 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 see de...

Page 150: ...false 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 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_user 1 is_pub...

Page 151: ...int 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 group 1 public group responsetype optional parameter text format response as text default xml format response as XML object EXAMPLES https url of smseagle http_api contact_update access_token 0005gO...

Page 152: ..._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 parameter error_text status error status xml xml error_text Wrong or missing number parameter error_text status error status xml Response when contact_id is wrong xml error_text Contact with the given id doe...

Page 153: ...rd 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 parameters result Wrong or missing contactname parameter result Wrong or missing contact_id parameter result Wrong or missing number parameter Response when contact_id is wrong result Contact with th...

Page 154: ...ame 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 0005gOjCOlMH8F2x contact_id 4 contactname johnlord RESPONSE Response OK Response when wrong logindata Invalid login or password Response when wrong access token Invalid access token Response when wrong par...

Page 155: ...tus 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 API Authentication login your user to login to SMSEagle see details in point API Authentication pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing co...

Page 156: ...rong 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_text Contact with the given id and name does not exists status error 43 Call with termination HTTP GET method HTTP GET METHOD https url of smseagle http_api call_with_termination Parameter Descripti...

Page 157: ...ing 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 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 xml er...

Page 158: ...dem_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 as extended JSON object EXAMPLES method phone call_with_termination params access_token 0005gOjCOlMH8F2x to 123456789 duration 30 RESPONSE Response result OK Response when wrong logindata result Inv...

Page 159: ...th 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 API Authentication login your user to login to SMSEagle see details in point API Authentication pass your password to login to SMSEagle name name for the created shift enabled 0 disabled 1 enabled mo...

Page 160: ..._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 xml error_text Wrong or missing name parameter error_text status error status xml 46 Phonebook shift create JSONRPC method HTTP POST METHOD https url of smseagle jsonrpc sms Parameter Description ac...

Page 161: ...t 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 ID of created shift status ok Sample response result shift_id 748 status ok Response when wrong logindata result error_text Invalid login or password status error Response when wrong access token re...

Page 162: ...token 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 Invalid access token Response when wrong parameters Wrong shift_id parameter RESPONSE XML Sample response xml shifts shift id_shift 62 id_shift name myshift name mon_from 08 00 mon_from mon_to 16 00 mon_t...

Page 163: ...ror_text Wrong id parameter error_text status error status xml Response when wrong parameters xml error_text Wrong enabled parameter error_text status error status xml 48 Phonebook shift read JSONRPC method HTTP POST METHOD https url of smseagle jsonrpc sms Parameter Description access_token authentication access token see details in point API Authentication login your user to login to SMSEagle se...

Page 164: ...6 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 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 parameters result Wrong enabled ...

Page 165: ...Response 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 https url of smseagle http_api shift_update Parameter Description access_token authentication access token see details in point API Authentication login your user to login to SMSEagle see details in p...

Page 166: ... 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 Response when 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 name parameter error_text status ...

Page 167: ...N 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 login or password Response when wrong access token result Invalid access token Response when wrong parameters result Wrong or missing name parameter result Wrong or missing shift_id parameter Response ...

Page 168: ...n 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 smseagle http_api shift_delete access_token 0005gOjCOlMH8F2x shift_id 24 RESPONSE Response OK Response when wrong logindata Invalid login or password Response when wrong access token Invalid access token...

Page 169: ...on 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 shift_id id of existing shift responsetype optional parameter simple format response as simple object with one result field default extended format response as extended JSON object EXAMPLES method ph...

Page 170: ...http_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 Authentication pass your password to login to SMSEagle shift_id id of existing shift or id s separated with comma contact_id id of contact The contact will be added to the shift responsetype optional parameter...

Page 171: ...when 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 status xml xml error_text Wrong or missing contact_id parameter error_text status error status xml Response when id is wrong xml error_text Shift with the given id does not exists error_text status e...

Page 172: ...shift_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 token result Invalid access token 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 gi...

Page 173: ...SEagle shift_id id of existing shift or id s separated with comma contact_id id of contact The contact will be added to the shift responsetype optional parameter text format response as text default xml format response as XML object EXAMPLES https url of smseagle http_api shift_removecontact access_token 0005gOjCOlMH8F2x shift_id 24 contact_id 1 RESPONSE Response OK Response when wrong logindata I...

Page 174: ...ror_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 exists error_text status error status xml 56 Phonebook shift remove contact JSONRPC method HTTP POST METHOD https url of smseagle jsonrpc sms Parameter Description access_token authentication access to...

Page 175: ...ntact_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 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 parameters result error...

Page 176: ...response 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 logindata Invalid login or password Response when wrong access token Invalid access token Response when modem doesn t exist Wrong modem number RESPONSE XML Response xml modem_status enabled disabled mo...

Page 177: ...r 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 with one result field default extended format response as extended JSON object BODY method sms get_modem_state params access_token 0005gOjCOlMH8F2x RESPONSE result enabled disabled Sample response re...

Page 178: ...SMSEagle 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 enabled disabled responsetype optional parameter text format response as text default xml format response as XML object EXAMPLES https url of smseagle http_api set_modem_state access_token 0005gOjCOlMH8F...

Page 179: ... 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 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 enabled disab...

Page 180: ...ng 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 Wrong modem state status error 61 User ID read HTTP GET method HTTP GET METHOD https url of smseagle http_api userid_read Parameter Description access_token authentication access token see details i...

Page 181: ...ong 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 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 username username to be queried response...

Page 182: ...esponse 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 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 login ...

Page 183: ...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 wrong or missing group_id parameter xml error_text Wrong or missing group_id parameter error_text status error status xml Response when wrong user_id parameter xml error_text Wrong user_id parameter e...

Page 184: ...field 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 mycontact1 Number 23456 id_user 1 is_public true ID 1693 Name mycontact3 Number 12345 id_user 3 is_public false Response when wrong or missing group_id parameter result Wrong or missing group_id paramet...

Page 185: ...scription 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 contact_id id of existing contact contactname name of existing contact status enabled disabled responsetype optional parameter text format response as text default xml format response as XML o...

Page 186: ...I Authentication login your user to login to SMSEagle see details in point API Authentication pass your password to login to SMSEagle contact_id id of existing contact contactname name of existing contact status enabled disabled responsetype optional parameter simple format response as simple object with one result field default extended format response as extended JSON object BODY method phoneboo...

Page 187: ...cation_mode 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 Authentication 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 response as XML o...

Page 188: ...atus error status xml 68 Phonebook contact get vacation mode JSONRPC 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 see details in point API Authentication pass your password to login to SMSEagle contact_id id of existing contact contactname name of...

Page 189: ... response result enabled Response when wrong logindata result Invalid login or password Response when wrong access token result Invalid access token RESPONSE EXTENDED Response result vacation_mode enabled disabled status 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 ...

Page 190: ...lugins 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 https www smseagle eu integration plugins ...

Page 191: ...atus 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 information about delivery status of the message For more information about possible values for Status column please refer to chapter Błąd Nie można odnaleźć źródła odwołania table Field Description Of Resp...

Page 192: ...is is a SQL test message Program Default_No_Compression 1 smseagle1 INSERT INTO user_outbox id_outbox id_user SELECT CURRVAL pg_get_serial_sequence outbox ID 1 In the above example the message will belong to user with id_user 1 default admin You can find id_user values for other users in table public user Field SenderID contains identification number of SMSEagle modem For modem 1 SenderID smseagle...

Page 193: ... number and 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 MultiPart UDH TextDecoded Coding Class SenderID VALUES 1234567 Program true 050003D30201 Lorem ipsum dolor sit amet consectetur adipiscing elit sed do eiusmod tempor incididunt ut labore et dolore m...

Page 194: ...Eagle MHD 8100 User s Manual 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 use only 153 characters in single message ...

Page 195: ... 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_allfolders db_delete_select script for deleting SMS from chosen databse folder Inbox Outbox SentItems Trash Usage db_delete_select inbox outbox sentitems trash Adding script to system cron daemon 1 C...

Page 196: ... 0 100 If modem is disconnected from cellular network GSM_Signal returns 0 1 3 6 1 4 1 8072 1 3 2 3 1 2 11 71 83 77 95 83 105 103 110 97 108 48 X GSM_NetName1 Returns cellular network name on modem 1 1 3 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 GSM_NetName X Returns cellular network name used on modem X 1 3 6 1 4 1 8072 1 3 2 3 1 2 12 71 83 77 95 78 101 116 78 97 109 1 ...

Page 197: ...TRIC NAME For example Result value for parameter GSM_Signal1 NET SNMP EXTEND MIB nsExtendOutputFull GSM_Signal1 If your chosen SNMP tool cannot access NET SNMP EXTEND MIB objects you can download MIB definitions from https 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 protoc...

Page 198: ...ET SNMP LIBRARY 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 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 ...

Page 199: ...ntrol By default SMSEagle devices uses SNMP v2 access control Using v3 can strengthen security however is not mandatory To easily switch to SNMP v3 access control we ve prepared special shell script located at opt smseagle directory 1 Log in via SSH using root account 2 Navigate to cd opt smseagle 3 Configuration script snmpv3 4 Script can run with following parameters i add ii del iii enablev2 iv...

Page 200: ...200 SMSEagle MHD 8100 User s Manual 6 To delete USER please run snmpv3 del 7 To disable v2 access policy run snmpv3 disablev2 8 To enable v2 access policy run snmpv3 enablev2 ...

Page 201: ...tem or whole node without requiring administrative intervention a process known as failover source Wikipedia SMSEagle NXS family devices their own failover mechanism based on HA cluster This feature allows you to assure high availability of SMSEagle devices in critical environments To enable failover HA cluster you need at least 2 devices aka nodes The failover feature monitors devices working in ...

Page 202: ...ork same subnet IP range 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 CLUSTER Failover cluster can be easily configured using web gui Configuration can be done in menu Settings tab Failover For each device in failover cluster enter virtual IP addre...

Page 203: ...this 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 cluster Failover feature uses KEEPALIVED MIB for SNMP monitoring EXAMPLE OF READING DEVICE CLUSTER STATE VALUE USING NET SNMP LIBRARY a Command for reading the result value snmpget v 2c c public ip of s...

Page 204: ...rsyslog 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 IP or FQDN address of receiving server PORT port on receiving server PROTOCOL one of the values tcp udp Example action type omfwd target 192 168 0 250 port 10514 protocol tcp action resumeRetryCount...

Page 205: ...ed 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 updates This will enable periodic checks once a month for available software updates If a new update is available a message Update Available will appear in menu Settings Sysinfo next to the current ...

Page 206: ...e MHD 8100 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 smseagle eu ...

Page 207: ...207 SMSEagle MHD 8100 User s Manual TROUBLESHOOTING I I I I I I ...

Page 208: ...rk name can be found under menu Settings Sysinfo Device logs Under menu Settings Sysinfo you can find latest lines of device logs modem log database log and system log In case of any problems with the device these logs are a valuable source of troubleshooting information Extended device logs can be downloaded via button Download device logs in menu Settings Sysinfo When the device is not reachable...

Page 209: ... to restore factory defaults proceed with the following steps 1 When the device is ready to operate STATUS LED is blinking 2 Press and hold SW button for 10 seconds 3 Release SW button after 10 seconds you will see Factory reset on display 4 Wait until system reboots Please note that after reboot the device will be finishing the process of factory reset therefore it can take longer for the system ...

Page 210: ...210 SMSEagle MHD 8100 User s Manual SERVICE REPAIR IV I ...

Page 211: ...e 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 Email support smseagle eu Phone 48 61 6713 413 The support service is provided by PROXIMUS Radoslaw Janowski ul Piątkowska 163 60 650 Poznan Poland WHEN CONTACTING SUPPORT TEAM BE PREPARED TO PROVIDE THE F...

Page 212: ...212 SMSEagle MHD 8100 User s Manual TECH SPECS SAFETY INFORMATION V I ...

Page 213: ...n less Dimensions width x depth x height 44 x 15 5 x 4 5 cm Weight 1 8 kg Casing metal rack mount Operating parameters o Operating temperature 32 140 F 0 60 C o Humidity 0 90 RH non condensing 8x Internal modem MHD 8100 3G o Waveband GSM UMTS o GSM GPRS quad band 850 900 1800 1900 MHz o UMTS 800 850 900 AWS 1700 1900 2100 MHz o Output power Rated E GSM 900 Class 4 DCS 1800 Class1 EDGE 900 Class E2...

Page 214: ...40V alternating current AC Frequency 50 60Hz single phase AC plug type IEC13 AC socket type IEC14 ANTENNA o Omnidirectional max 2dBi o Wavebands UMTS LTE o Plug type SMA o Impedance 50 Ohm SENDING RECEIVING THROUGHPUT Incoming transmission rate up to 8x 30 SMS min Outgoing transmission rate up to 8x 30 SMS min SOFTWARE PLATFORM Operating system Ubuntu 18 04 built in Apache2 web server built in Pos...

Page 215: ...215 SMSEagle MHD 8100 User s Manual watchdog mechanism for built in modems failover mechanism for built in modems modern responsive web interface ...

Page 216: ...uipment 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 hospitals airports aircrafts etc where there is risk of explosion such as gasoline stations oil refineries etc It is responsibility of the user to enforce the country regulation and the specific environ...

Page 217: ...be determined 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 separation between the equipment and receiver Connect the equipment to an outlet on a circuit different from that to which the receiver is connected Consult the dealer or an experienced radio TV ...

Page 218: ... Supplier s Declaration of Conformity will be identical to the unit tested and found acceptable with the standards The equipment will continue to comply within the variation that can be expected due to quantity production and testing on a statistical basis The records maintained by the responsible party will continue to reflect the equipment being produced under this Supplier s Declaration of Conf...

Page 219: ...of conformity is available at the following internet address www smseagle eu certification RF Exposure Limits This device complies with radiation exposure limits set forth for an uncontrolled environment In order to avoid the possibility of exceeding the radio frequency exposure limits humanproximity to the antenna shall not be less than 23 cm 9 inches during normal operation Disposal and Recyclin...

Page 220: ...etyp Chemisches System CR2032 Lithium Angaben zur sicheren Entnahme der Batterien oder der Akkumulatoren Öffnen Sie die obere Abdeckung des Geräts Die Batterie ist auf der Rückseite des Geräts angebracht Entnehmen Sie vorsichtig die Batterie Die Batterie und das Gerät können jetzt getrennt entsorgt werden Restriction of Hazardous Substances Directive RoHS European Union RoHS SMSEagle devices sold ...

Page 221: ...221 SMSEagle MHD 8100 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 ...