Difference between revisions of "Get History"

From Boxis.net API Docs
Jump to: navigation, search
(Example in Json (Success))
Line 80: Line 80:
 
  "resulttxt":"success",
 
  "resulttxt":"success",
 
  "params":{
 
  "params":{
   "senders":{
+
   "history":{
 
     "sms1":{
 
     "sms1":{
 
       "sender":"boxis.net",
 
       "sender":"boxis.net",

Revision as of 12:44, 9 May 2012

SMS Function: getHistory

With this command, you are able to view history of sending text messages

Input params

- version (string)

API version (e.g. '1.0')

- timestamp (String)

Sequence of characters, denoting the date and time (e.g '1336553826')

- username (String)

User e-mail address (e.g 'mail1@example.com')

- authcode (String)

md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))

- section (String)

API module name. Use 'sms' value

- action (String)

API module function. Use 'getHistory' value

- datefrom (String)

Start date in 'yyyy-mm-dd hh:mm' format. When datefrom and dateto value is empty function returns information about all sms

- dateto (String)

End date in 'yyyy-mm-dd hh:mm' format. When datefrom and dateto value is empty function returns information about all sms

Output params

Example in XML (Success)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <history>
      <sms1>
        <sender>boxis.net</sender>
        <reciptient>48514151563</reciptient>
        <date>2012-05-09 10:28:00</date>
        <parts>1</parts>
        <credit>1</credit>
        <type>scheduled</type>
      </sms1>
      <sms2>
        <sender>boxis.net</sender>
        <reciptient>48717609573</reciptient>
        <date>2012-05-09 10:20:00</date>
        <parts>1</parts>
        <credit>1</credit>
        <type>sent</type>
      </sms2>
  </history>
  <timestamp>1336558351</timestamp>
</return>

Example in XML (Error)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>0</result>
  <resulttxt>error: {error description}</resulttxt>
  <timestamp>1335767184</timestamp>
</return>

Example in Json (Success)

{"result":"1",
 "resulttxt":"success",
 "params":{
   "history":{
     "sms1":{
       "sender":"boxis.net",
       "reciptient":"48514151563",
       "date":"2012-05-09 10:28:00",
       "parts":"1","credit":"1",
       "type":"scheduled"},
     "sms2":{
       "sender":"boxis.net",
       "reciptient":"48614606553",
       "date":"2012-05-09 10:20:00",
       "parts":"1",
       "credit":"1",
       "type":"sent"}}
 "timestamp":1335777400}

Example in Json (Error)

{"result":"0",
 "resulttxt":"Error: {error description}",
 "timestamp":1335777400}