User Manual

57 | SMSEagle NXS-9700-3G | User’s Manual
{"result": {"message_id":"[ID of message in outbox]","status":"ok"}}
Sample response: {"result": {"message_id":"748","status":"ok"}}
Response (when wrong logindata):
{"result": {"error_text":"Invalid login or password","status":"error"}}
Response (when wrong parameters):
{"result": {"error_text":" Wrong or missing >>udh<< parameter
","status":"error"}}
Response (when wrong parameters):
{"result": {"error_text":"Wrong or missing >>data<< parameter",
"status":"error"}}
11. Read SMS: HTTP GET method
HTTP GET METHOD:
https://url-of-smseagle/index.php/http_api/read_sms
Parameter
Description
login
your user to login to SMSEagle
pass
your password to login to SMSEagle
folder
one of the following: inbox, outbox, sentitems
idfrom
(optional parameter) minimal message-id
idto
(optional parameter) maximum message-id
from
(optional parameter) telephone number of SMS sender (for inbox)
to
(optional parameter) telephone number of SMS receiver (for sentitems)
datefrom
(optional parameter) date and time in format YYYYmmDDHHMMSS (YYYY – year,
mm – month, DD – day, HH – hour, MM – minutes, SS – seconds). Show only
messages sent/received on this date/time and later
dateto
(optional parameter) date and time in format YYYYmmDDHHMMSS (YYYY – year,
mm – month, DD – day, HH – hour, MM – minutes, SS – seconds). Show only
messages sent/received on this date/time and earlier
limit
(optional parameter) 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
EXAMPLES:
Show all messages from inbox:
https://url-of-smseagle/index.php/http_api/read_sms?
login=john&pass=doe&folder=inbox