Returns a specified sent or received fax file in PDF or TIFF format

POST Variables

 

Variable Name Var Type Type Description
action String Required Must be “Retrieve_Fax”
access_id Integer Required Account Number
access_pwd String Required Password on the user’s account
sFaxFileName String Required* sFaxFileName returned from Get_Fax_Inbox or Get_Fax_Outbox
sFaxDetailsID Integer Required* sFaxDetailsID of the fax – the ID is located after the “|” (pipe) character of the sFaxFileName
sDirection String Required “IN” or “OUT” for inbound or outbound fax
sSubUserID Integer Optional The account number of a sub account, if you want to use a master account to download a sub account’s fax
sResponseFormat String Optional “XML” or “JSON” – Default is JSON
sFaxFormat String Optional “PDF” or “TIF” – defaults to account settings if not supplied
sMarkasViewed String Optional “Y” – mark fax as viewed once method completes successfully.
“N” or not provided – leave viewed status as is.

 

*NOTE: Either the sFaxFileName or the sFaxDetailsID must be supplied

 

 

Returned Variables (JSON or XML Encoded)

 

Status string “Success” or “Failed”
Result string Base64 encoded fax file contents. The file format will be in PDF or TIF format depending on format requested or the settings selected on your account
Note: If an error is found then the reason for the failure will be in the Result string

 

 

Examples

PHP using cURL

  1. <?php
  2.    $postVariables = array(
  3.      ‘action’         => ‘Retrieve_Fax’,
  4.      ‘access_id’      => ‘12345’,
  5.      ‘access_pwd’     => ‘myPassword’,
  6.      ‘sFaxDetailsID’  => ‘12345678’,
  7.      ‘sDirection’     => ‘OUT’,
  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 {
  33.       echo “Success!”;
  34.       $decodedResult = json_decode($result, 1);
  36.       // save the result to a file
  37.       file_put_contents(“myFax.pdf”, base64_decode($decodedResult[‘Result’]));
  38.    }
  39. ?>

 

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->Retrieve_Fax(array(
  13.         ‘sFaxDetailsID’ => ‘12345678’,
  14.         ‘sDirection’    => ‘OUT’,
  15.       ));
  16.   }
  17.   catch (Exception $e) { //display error when exception is thrown
  18.       die(“Error: $e“);
  19.   }
  21.   if ( $srFax->getRequestStatus () ) {
  22.      echo “Success!”;
  24.      //write file to a file
  25.      $srFax->saveLastResponseAsFile(“myRetrievedFax.pdf”,“../srfax_API_Class/”);
  27.   } else {
  28.       echo “ERROR: “ . $srFax->getRequestResponse ();
  29.   }
  31. ?>