SMSEagle NPE-9300-GPRS/3G Скачать руководство пользователя страница 36 | Manualshive

Страница: 36 / 107

background image

Page

36

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.

For your convenience sample usage of SMSEagle’s API in most popular programming languages are available
at:

http://www.smseagle.eu/code-samples/

1. Send SMS: HTTP GET method

HTTP GET METHOD:

https://url-of-smseagle/index.php/http_api/send_sms

PARAMETERS:

Parameter

Description

login

your user to login to SMSEagle

pass

your password to login to SMSEagle

to

recipient telephone number (or numbers separated with comma)

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

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) 0 = normal SMS (default), 1 = SMS will be sent as flash
message

oid

(optional parameter) This attribute specifies a user-defined unique ID that is
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 value will be automatically assigned to incoming message only if
incoming phone number matches exactly the phone number (including country
code) from outgoing message.

modem_no

(optional parameter) sending modem number (only for multimodem devices)

responsetype

(optional parameter) text = format response as text (default), xml = format
response as XML object

«
...
34
35
36
37
38
...
»

Содержание NPE-9300-GPRS/3G

Страница 1: ...Page 1...

Страница 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 witho...

Страница 3: ...Autoreply plugin 19 Network Monitoring plugin 20 Email to SMS plugin 24 Email to SMS Poller 26 SMS to Email plugin 28 Callback URL plugin 29 SMS Forward 31 Periodic SMS 32 Digital input output 33 SMS...

Страница 4: ...read JSONRPC method 67 27 Phonebook group update HTTP GET method 68 28 Phonebook group update JSONRPC method 69 29 Phonebook group delete HTTP GET method 70 30 Phonebook group delete JSONRPC method 7...

Страница 5: ...g logs to external server 97 Automatic software updates checks 98 3 TROUBLESHOOTING 99 Verification of LEDs 100 Checking the device logs 100 When the device is not reachable 100 Restoring factory defa...

Страница 6: ...Page 6 1 GET READY TO START...

Страница 7: ...Page 7 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...

Страница 8: ...tall SIM Card when the device is SWITCHED OFF SIM Card slot is located at the bottom of the device Use a ball pen or small screwdriver to eject SIM Card tray Insert card into tray and push it gently i...

Страница 9: ...mputer PC must be in the same network subnet as the device Taking into account the factory settings of the device listed above a computer must have following IP configuration IP address 192 168 0 X Su...

Страница 10: ...10 Example of computer IP configuration in Windows b VERIFY YOUR CONNECTION Properly connected device should respond to the ping command Example of ping after a proper connection to PC c LOG IN TO SMS...

Страница 11: ...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 CONFIGURE IP SETTINGS Click on menu position S...

Страница 12: ...automatically Press Save button e SETTING SIM CARD PIN 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 Maintenance Ta...

Страница 13: ...Page 13 2 USING OF SMSEAGLE...

Страница 14: ...M Card Slot SIM SIM card slot SD Card Slot SD Slot for additional SD MMC card Ethernet Port ETH Ethernet RJ45 socket Antenna ANT Antenna socket Power LED PWR LED indicating power on User LED USER LED...

Страница 15: ...res Sending Receiving SMS managing messages with Inbox Outbox Sent Items Smartphone like conversation mode messages are nicely grouped by phone number You can easily track history of what you send and...

Страница 16: ...book 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 file Set contact...

Страница 17: ...sage will be skipped or moved to beginning of a next shift To start using working shifts define shifts here and add contact to a shift in contact details Screenshot of shift management in phonebook Re...

Страница 18: ...iew 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...

Страница 19: ...sponse PLUGIN CONFIGURATION Plugin Autoreply allows to add many autoreply rules Each rule can be enabled or disabled by user Screenshot from plugin main window For each rule user can define When autor...

Страница 20: ...le 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 feat...

Страница 21: ...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 edit delete your tasks dis...

Страница 22: ...ed return types numeric string increase a default timeout value for busy servers by default we set it to 30 seconds Define a schedule choose if task should be always enabled or disable it in chosen ti...

Страница 23: ...ME puts a taskname inside SMS text HOST hostname or IP address RESPONSE message received in case of no response from server service TIMESTAMP timestamp of an error Receive SMS alerts be immediately al...

Страница 24: ...ok 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 me...

Страница 25: ...lugin set Email2sms active to Yes if you want to include a subject of an email in SMS message set What to do with email subject setting to Include in SMS The email subject will be appended at the begi...

Страница 26: ...ve to send an email to specified email account with email subject containing mobile number or phonebook contact group name BASIC EXAMPLE For example such email message TO smseagle mycompany com FROM j...

Страница 27: ...imum number of characters Maximum allowed length of SMS message is 1300 characters If you want to include special national characters enable Unicode encoding of SMS text Choose protocol from IMAP or P...

Страница 28: ...he email address of 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 fix...

Страница 29: ...ail or To fixed email address enter an email address to which incoming SMS messages are to sent enter SMTP configuration for your SMTP server that will be used for sending emails Callback URL plugin C...

Страница 30: ...sed to your callback URL in parameter apikey If you leave the field blank apikey parameter will not be passed to your callback URL Test URL button allows to test whether your Callback URL configuratio...

Страница 31: ...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...

Страница 32: ...ntly 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 The rul...

Страница 33: ...pull up see more https en wikipedia org wiki Pull up_resistor and are represented by the following states Logical level DI Voltage LOW 0 GROUND HIGH 1 OPEN CIRCUIT The digital outputs of SMSEagle NPE...

Страница 34: ...dow DIGITAL OUTPUTS For each processing rule for digital output user can define The rule name Port number 1 2 On what condition digital output should be set all incoming messages when incoming SMS com...

Страница 35: ...Page 35 Screenshot from digital output Add or edit rule window...

Страница 36: ...ighpriority 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 enco...

Страница 37: ...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 status ok status xm...

Страница 38: ...r 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 simple format response as simple...

Страница 39: ...ty 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 charac...

Страница 40: ...p jsonrpc sms Parameter Description login your user to login to SMSEagle pass your password to login to SMSEagle groupname group name defined in your SMSEagle Phonebook The group must be defined as Pu...

Страница 41: ...e in outbox Sample response result OK ID 297 Response when wrong logindata result Invalid login or password Response when wrong parameters result Wrong parameters RESPONSE EXTENDED Response result mes...

Страница 42: ...ameter 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...

Страница 43: ...k 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...

Страница 44: ...t exist result Invalid contact name contact_name Response when wrong parameters result Wrong parameters RESPONSE EXTENDED Response result message_id ID of message in outbox status ok Sample response r...

Страница 45: ...logindata Invalid login or password Response when wrong parameters Wrong parameters RESPONSE XML Response xml message_id ID of message in outbox message_id status ok status xml Sample response xml mes...

Страница 46: ...se result OK ID 297 Response when wrong logindata result Invalid login or password Response when wrong parameters result Wrong parameters RESPONSE EXTENDED Response result message_id ID of message in...

Страница 47: ...103534D534561676C65000101 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 miss...

Страница 48: ...ith one result field default extended format response as extended JSON object EXAMPLES method sms send_binary_sms params login john pass doe to 1234567 udh 0605040B842 3F0 data EA0601AE02056A0045C60C0...

Страница 49: ...ssages sent received on this date time and later dateto optional parameter date and time in format YYYYmmDDHHMMSS YYYY year mm month DD day HH hour MM minutes SS seconds Show only messages sent receiv...

Страница 50: ...nse inbox folder xml messages item UpdatedInDB 2016 11 17 13 23 47 UpdatedInDB ReceivingDateTime 2015 01 20 16 13 57 ReceivingDateTime Text 005400650073007400200032 Text SenderNumber 1234567 SenderNum...

Страница 51: ...ms idfrom optional parameter minimal message id from optional parameter telephone number of SMS sender for inbox to optional parameter telephone number of SMS receiver for sentitems datefrom optional...

Страница 52: ...od sms read_sms params login john pass doe folder inbox from 481234567 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...

Страница 53: ...UpdatedInDB 2016 11 14 10 15 58 ReceivingDateTime 2016 06 16 14 47 10 Text 004F00640070002000320020 SenderNumber 1234 Coding 8bit UDH SMSCNumber 48790998250 Class 1 TextDecoded 8b123sad ID 24 Recipien...

Страница 54: ...D admin id_folder 3 UpdatedInDB 2016 06 16 14 48 56 InsertIntoDB 2016 06 16 12 48 45 SendingDateTime 2016 06 16 14 48 56 DeliveryDateTime null Text 0074006500730074006F007500740033 Coding Default_No_C...

Страница 55: ...EXAMPLES Delete message with id 1234 from inbox https url of smseagle index php http_api delete_sms login john pass doe folder inbox idfrom 1234 idto 1234 Delete messages with id 1234 1250 from inbox...

Страница 56: ...format response as extended JSON object EXAMPLES Delete message with id 1234 from inbox method sms delete_sms params login john pass doe folder inbox idfrom 1234 idto 1234 Delete messages with id 123...

Страница 57: ...et_queue_length login john pass doe RESPONSE Response number of messages in database that wait to be processed by GSM modem Sample response 7 Response when wrong logindata Invalid login or password Re...

Страница 58: ...Response result number of messages in database that wait to be processed by GSM modem Sample response result 7 Response result Invalid login or password Response result Wrong parameters RESPONSE EXTEN...

Страница 59: ...ng logindata Invalid login or password Response when wrong parameters Wrong parameters RESPONSE XML Response xml queue_length number of messages in database Inbox folder queue_length status ok status...

Страница 60: ...rs RESPONSE EXTENDED Response result inbox_length number of messages in database Inbox folder status ok Sample response result inbox_length 3 status ok Response when wrong logindata result error_text...

Страница 61: ...r password error_text status error status xml Response when wrong parameters xml error_text Wrong parameters error_text status error status xml 20 Get sentitems length JSONRPC method HTTP POST METHOD...

Страница 62: ...er 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 responsetyp...

Страница 63: ...login to SMSEagle pass your password to login to SMSEagle modem_no optional parameter modem number to be queried default 1 Used only in multimodem devices responsetype optional parameter simple forma...

Страница 64: ...ameter 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 index php http_api group_cre...

Страница 65: ...object with one result field default extended format response as extended JSON object EXAMPLES method phonebook group_create params login john pass doe groupname myusers public 1 RESPONSE Response re...

Страница 66: ...rmat response as XML object EXAMPLES https url of smseagle index php http_api group_read login john pass doe public 1 uid 12 RESPONSE Sample response link Response when no data No data to display Resp...

Страница 67: ...error status xml 26 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 lo...

Страница 68: ...sult error_text No data to display status error Response when wrong logindata result error_text Invalid login or password status error Response when wrong parameters result error_text Wrong or missing...

Страница 69: ...tus ok status xml Response when wrong logindata xml error_text Invalid login or password error_text status error status xml Response when wrong parameters xml error_text Wrong or missing groupname par...

Страница 70: ...issing groupname parameter result Wrong or missing group_id parameter Response when group_id is wrong result Group with the given id does not exists RESPONSE EXTENDED Response result status ok Respons...

Страница 71: ...oupname parameter Wrong or missing group_id parameter Response when group_id is wrong Group with the given id and name does not exist RESPONSE XML Response xml status ok status xml Response when wrong...

Страница 72: ...me myuse rs RESPONSE Response result OK Response when wrong logindata result Invalid login or password Response when wrong parameters result Wrong or missing groupname parameter result Wrong or missin...

Страница 73: ...group_addcontact login john pass doe group_id 2 contact_id 1 RESPONSE Response OK Response when wrong logindata Invalid login or password Response when wrong parameters Wrong or missing group_id param...

Страница 74: ...e added to 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 gr...

Страница 75: ...agle 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 parame...

Страница 76: ...status xml 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 t...

Страница 77: ...he given id does not exists status error result error_text Contact with the given id does not exists status error 35 Phonebook contact create HTTP GET method HTTP GET METHOD https url of smseagle inde...

Страница 78: ...ssword error_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 number...

Страница 79: ...ID of created contact status ok Sample response result contact_id 2 status ok Response when wrong logindata result error_text Invalid login or password status error Response when wrong parameters res...

Страница 80: ...mple 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...

Страница 81: ...tacts default value 1 public contacts uid optional parameter id of user who created the contact responsetype optional parameter simple format response as simple object with one result field default ex...

Страница 82: ...text Invalid login or password status error Response when wrong parameters result error_text Wrong or missing uid parameter status error result error_text Wrong or missing public parameter status erro...

Страница 83: ...tact 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...

Страница 84: ...r 123456789 public 1 RESPONSE Response result OK Response when wrong logindata result Invalid login or password Response when wrong parameters result Wrong or missing contactname parameter result Wron...

Страница 85: ...login john pass doe contact_id 4 contactname johnlord RESPONSE Response OK Response when wrong logindata Invalid login or password Response when wrong parameters Wrong or missing contactname paramete...

Страница 86: ...h one result field default extended format response as extended JSON object EXAMPLES method phonebook contact_delete params login john pass doe contact_id 4 contactname j ohnlord RESPONSE Response res...

Страница 87: ...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...

Страница 88: ...gration 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 SM...

Страница 89: ...sword postgreeagle Injecting short SMS using SQL The simplest example is short text message limited to 160 chars INSERT INTO outbox DestinationNumber TextDecoded CreatorID Coding Class SenderID VALUES...

Страница 90: ...e 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...

Страница 91: ...Page 91 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...

Страница 92: ...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...

Страница 93: ...1 116 78 97 109 101 49 FolderOutbox_Total Returns number of SMS messages in Outbox folder outgoing queue length 1 3 6 1 4 1 8072 1 3 2 3 1 2 17 70 111 108 10 0 101 114 73 110 98 11 1 120 95 84 111 116...

Страница 94: ...any tools available for SNMP protocol for example NET SNMP library for Linux or iReasoning MiB Browser for Windows EXAMPLE OF READING GSM_SIGNAL VALUE USING NET SNMP LIBRARY a Command for reading the...

Страница 95: ...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...

Страница 96: ...ve prepared special shell script located at mnt nand user smseagle directory 1 Log in via SSH using root account 2 Navigate to cd mnt nand user smseagle 3 Configuration script snmpv3 4 Script can run...

Страница 97: ...ion is managed using a configuration file located at etc rsyslog conf Forwarding all logs to external server using TCP port At the bottom of the configuration file add server_ip_address port eg 192 16...

Страница 98: ...ation 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...

Страница 99: ...Page 99 3 TROUBLESHOOTING...

Страница 100: ...ux 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...

Страница 101: ...D is disabled do not proceed if you don t have that state 1 Press and hold SW button for 10 seconds Restore service is counting down 2 Release SW button after 10 seconds User LED will begin to blink S...

Страница 102: ...Page 102 4 SERVICE AND REPAIR...

Страница 103: ...this manual SMSEagle Support Team is available by email or telephone Support Email support smseagle eu Support telephone 48 61 6713 411 The support service is provided by Proximus Software ul Pi tkow...

Страница 104: ...Page 104 5 TECH SPECS AND SAFETY INFORMATION...

Страница 105: ...ion Operating parameters o Operating temperature 10 60 C o Humidity 5 95 RH no condensation Modem GSM GPRS o Waveband GSM GPRS EGPRS 900 1800 1900 MHz o Compatible with GSM phase 2 2 o Class 4 2W 900...

Страница 106: ...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 built in Postfix email s...

Страница 107: ...ipment the use of this product may be dangerous and has to be avoided in the following areas where it can interfere with other electronic devices in environments such as hospitals airports aircrafts e...

Отзывы:

Нет отзывов

Похожие инструкции для NPE-9300-GPRS/3G

Бренд: FACTBIRD Страницы: 2

Бренд: C-Bus Страницы: 36

Бренд: THOR Страницы: 20

Бренд: Iget Страницы: 12

EliteConnect SMCWHSG14-G

Бренд: SMC Networks Страницы: 2

Бренд: Delta Страницы: 2

Бренд: ZyXEL Communications Страницы: 2

Mobile Gateway 3.0

Бренд: SmartKitchen Страницы: 4

Бренд: WePresent Страницы: 8

1898921 RSL 433 MHz

Бренд: Sygonix Страницы: 45

Бренд: Innovaphone Страницы: 164

SIMATIC IOT2020

Бренд: Siemens Страницы: 2

SIMATIC IOT Gateway MQTT

Бренд: Siemens Страницы: 2

MindConnect Nano

Бренд: Siemens Страницы: 2

Instabus/DALI Gateway N 141

Бренд: Siemens Страницы: 5

SIMATIC IOT2050

Бренд: Siemens Страницы: 25

GAMMA 5WG1 143-1AB01

Бренд: Siemens Страницы: 2

Бренд: Siemens Страницы: 6

Бренды по названию

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Популярные бренды

Загрузить еще бренды