Retrieve a list of faxes queued

POST Variables

 

Variable Name Type Var Type Description
action String Required Must be “Get_Faxes_Queued”
access_id Integer Required Account Number
access_pwd String Required Password on the user’s account
sResponseFormat String Optional “XML” or “JSON” – Default is JSON
sIncludeSubUsers String Optional Set to “Y” if you want to include faxes received by a sub user of the account as well

 

Notes:

  • If you want to use sIncludeSubUsers, you will need to use the access_id and access_pwd of the Master Account

 

 

Returned Variables (JSON or XML Encoded)

 

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

Array[#]->array(
  FaxDetailsID   => Integer,
  FileName       => String(75), 
  Status         => String(15), 
  DateQueued     => String,
  ToFaxNumber    => String(20),
  EpochTime      => String,
  Subject        => String(128),
  RefNum         => String(20),
  Pages          => Integer, 
  Size           => Integer,
  User_FaxNumber => String(20),
  SubmittedFiles => String,
)

If sIncludeSubUsers is set to “Y” then one additional variables are returned in the array:

User_ID         => Integer
Note: If an error is found then the reason for the failure will be in the Result string

 

Notes:

  • Both Date and Epoch Time are adjusted to your date/timezone settings
  • Epoch Time is a unix time stamp of the Date field
    • https://en.wikipedia.org/wiki/Unix_time

 

 

Examples

PHP using cURL

  1. <?php
  3. $postVariables = array(
  4. ‘action’ => ‘Get_Faxes_Queued‘,
  5. ‘access_id’ => ‘12345’,
  6. ‘access_pwd’ => ‘myPassword’,
  7. ‘sSubUserID’ => ‘Y’
  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. }
  34. ?>

 

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_Faxes_Queued(array(
  13. ‘sSubUserID’ => ‘Y’
  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. ?>