Deletes specified received or sent faxes

POST Variables

 

Variable Name Var Type Type Description
action String Required Must be “Delete_Fax”
access_id Integer Required Account Number
access_pwd String Required Password on the user’s account
sFaxFileName_x String Required* sFaxFileName returned from Get_Fax_Inbox or Get_Fax_Outbox. You are able to provide an unlimited number of fax file names by replacing the “x” with a sequential number
sFaxDetailsID_x String Required* sFaxDetailsID of the fax – the ID is located after the “|” (pipe) character of the sFaxFileName. You are able to provide an unlimited number of fax ID’s by replacing the “x” with a sequential number
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 delete a
sub account’s fax
sResponseFormat String Optional “XML” or “JSON” – Default is JSON

 

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

 

 

Returned Variables (JSON or XML Encoded)

 

Status string “Success” or “Failed”
Result string Empty String
Note: If an error is found then the reason for the failure will be in the Result string

 

 

Examples

PHP using cURL

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

 

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->Delete_Fax(array(
  13. ‘sFaxDetailsID_1’ => ‘12345678’,
  14. ‘sFaxDetailsID_2’ => ‘87654321’,
  15. ‘sDirection’ => ‘OUT’,
  16. ));
  17. }
  18. catch (Exception $e) { //display error when exception is thrown
  19. die(“Error: $e“);
  20. }
  22. if ( $srFax->getRequestStatus () ) {
  23. echo “Success! Response “ . print_r($srFax->getRequestResponse (), 1);
  25. } else {
  26. echo “ERROR: “ . $srFax->getRequestResponse ();
  27. }
  29. ?>