Latest revision as of 18:26, 1 June 2015

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:ss' format. When datefrom and dateto value is empty function returns information about all sms

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

Example URL with POST values

https://api.boxis.net/
POST: version=1.0&returntype=xml&timestamp=1337853467&username=your@mail.com&authcode=1234567890&section=sms&action=getHistory&datefrom=2012-05-09 10:00:00&dateto=2012-05-09 11:00:00

Output params

Example in XML (Success)

<?xml version="1.0" encoding="UTF-8"?>
<return>
  <result>1</result>
  <resulttxt>success</resulttxt>
  <history>
      <sms1>
        <sms_id>1385881206195280690</sms_id>
        <sender>boxis.net</sender>
        <reciptient>4179XXXXXXX</reciptient>
        <date>2012-05-09 10:28:10</date>
        <status_date>2012-05-09 10:29:21</status_date>
        <parts>1</parts>
        <credit>1</credit>
        <type>scheduled</type>
      </sms1>
      <sms2>
        <sms_id>1385898240874104160</sms_id>
        <sender>boxis.net</sender>
        <reciptient>4179XXXXXXX</reciptient>
        <date>2012-05-09 10:20:00</date>
        <status_date>2012-05-09 10:20:07</status_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":{
       "sms_id":"1385881206195280690",
       "sender":"boxis.net",
       "reciptient":"4179XXXXXXX",
       "date":"2012-05-09 10:28:10",
       "status_date":"2012-05-09 10:29:21",
       "parts":"1","credit":"1",
       "type":"scheduled"},
     "sms2":{
       "sms_id":"1385898240874104160",
       "sender":"boxis.net",
       "reciptient":"4179XXXXXXX",
       "date":"2012-05-09 10:20:00",
       "status_date":"2012-05-09 10:20:07",
       "parts":"1",
       "credit":"1",
       "type":"sent"}}
 "timestamp":1335777400}

Example in JSON (Error)

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

Example using our PHP Class

/* API LOGIN DETAILS */
$email    = 'your@mail.com';    // your username
$apikey   = '1234567890';        // your apikey

/* API COMMAND DETAILS */
$apitype  = 'sms';
$command  = 'getHistory';
$params   = array(
    'returntype' => 'xml',
    'datefrom' => '2012-05-09 10:00:00',
    'dateto' => '2012-05-09 11:00:00'
);

/* PROCESS THE ACTION */
$boxisAPI = new BoxisAPIConnection($email, $apikey);
$return = $boxisAPI->call($apitype, $command, $params, $timestamp);

/* TIMESTAMP SYNCHRONIZATION (JSON EXAMPLE)
if($return['timestamperror']) {
    $timestamp = $return['timestamp'];
    $return = $boxisAPI->call($apitype, $command, $params, 'json', $timestamp);
}
*/

/* TIMESTAMP SYNCHRONIZATION (XML EXAMPLE)*/
/*
if($return->timestamperror) {
    $timestamp = $return->timestamp;
    $return = $boxisAPI->call($apitype, $command, $params, 'xml', $timestamp);
}
/*