Retrieve the status of multiple sent faxes

POST Variables

 

Variable Name Var Type Type Description
action String Required Must be “Get_MultiFaxStatus”
access_id Integer Required Account Number
access_pwd String Required Password on the user’s account
sFaxDetailsID String Required Multiple FaxDetailIDs can be requested by separating each FaxDetailsID with a “|” (pipe) character
sResponseFormat String Optional “XML” or “JSON” – Default is JSON

 

 

Returned Variables (JSON or XML Encoded)

 

Status string “Success” or “Failed”
Result string Array of the fax properties as follows:

Array[#]->array(
  FileName     => String(75),
  FaxDetailsID => Integer,
  SentStatus   => String(15), 
  DateQueued   => String,
  DateSent     => String,
  EpochTime    => String,
  ToFaxNumber  => String(20)
  Pages        => Integer,  
  Duration     => Integer, 
  RemoteID     => String(40), 
  ErrorCode    => String(75), 
  Size         => Integer,
  AccountCode  => String,
)
Note: If an error is found then the reason for the failure will be in the Result string

 

 

Possible Values for “SentStatus”:

  • In Progress
  • Sent
  • Failed
  • Sending Email
  • Unknown
    • If you receive a status of “Unknown”, you will also see “FaxDetailsID Not Found”. This means that the FaxDetailsID(s) provided where not valid or the fax was not queued due to a conversion error. If you feel like you got this message in error, please contact Customer Support

 

NOTES:

  • The DateQueued and DateSent will reflect your account’s timezone settings
  • EpochTime is a unix time stamp of the DateSent field
    • https://en.wikipedia.org/wiki/Unix_time
  • ErrorCode will be a string describing the error encountered. There is a wide range of possible errors, the most frequent of which are “Busy”, “No Answer”, and “No Remote Fax”.

 

Examples

PHP using cURL

  1. <?php
  3.    $postVariables = array(
  4.      ‘action’         => ‘Get_MultiFaxStatus’,
  5.      ‘access_id’      => ‘12345’,
  6.      ‘access_pwd’     => ‘myPassword’,
  7.      ‘sFaxDetailsID’  => ‘12345678|9875432’,
  8.    );
  10.    $curlDefaults = array(
  11.        CURLOPT_POST           => 1,
  12.        CURLOPT_HEADER         => 0,
  13.        CURLOPT_URL            => “https://secure.srfax.com/SRF_SecWebSvc.php”,
  14.        CURLOPT_FRESH_CONNECT  => 1,
  15.        CURLOPT_RETURNTRANSFER => 1,
  16.        CURLOPT_FORBID_REUSE   => 1,
  17.        CURLOPT_TIMEOUT        => 60,
  18.        CURLOPT_SSL_VERIFYPEER => false,
  19.        CURLOPT_SSL_VERIFYHOST => 2,
  20.        CURLOPT_POSTFIELDS     => http_build_query($postVariables),
  21.    );
  23.    $ch = curl_init();
  24.    curl_setopt_array($ch, $curlDefaults);
  26.    $result = curl_exec($ch);
  28.    if (curl_errno($ch)) {
  29.        echo “Error – “ . curl_error($ch);
  30.    }
  31.    else {
  32.        echo “Result:” . print_r( json_decode($result, true), 1 );
  33.    }
  35. ?>;

 

PHP using SRFax Object

  1. <?php
  3.   require_once (“srFax_class.php”);
  5.   $accountID        = “12345”;
  6.   $accountPassword  = “myPassword”;
  8.   // instantiate object with Account ID and Password
  9.   $srFax = new srFax ( $accountID, $accountPassword );
  11.   try {
  12.       $srFax->Get_MultiFaxStatus(array(
  13.           ‘sFaxDetailsID’ => ‘12345678|98765432’,
  14.       ));
  15.   }
  16.   catch (Exception $e) { //display error when exception is thrown
  17.       die(“Error: $e“);
  18.   }
  20.   if ( $srFax->getRequestStatus () ) {
  21.       echo “Success! Response “ . print_r($srFax->getRequestResponse (), 1);
  23.   } else {
  24.       echo “ERROR: “ . $srFax->getRequestResponse ();
  25.   }
  27. ?>;