Retrieve a list of faxes sent for a specified period of time
POST Variables
Variable Name | Type | Var Type | Description |
action | String | Required | Must be “Get_Fax_Outbox” |
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 |
sPeriod | String | Optional | “ALL” or “RANGE” if not provided defaults to “ALL” |
sStartDate | String | Optional | Only required if “RANGE” is specified in sPeriod – date format must be “YYYYMMDD” |
sEndDate | String | Optional | Only required if “RANGE” is specified in sPeriod – date format must be “YYYYMMDD” |
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( FileName => String(75), SentStatus => String(15), DateQueued => String, DateSent => String, EpochTime => String, ToFaxNumber => String(20) Pages => Integer, Duration => Integer, RemoteID => String(40), ErrorCode => String(75), AccountCode => String(20), SenderEmail => String(75), Subject => String(128), Size => Integer SubmittedFiles => String, ) If sIncludeSubUsers is set to “Y” then two additional variables are returned in the array: User_ID => Integer User_FaxNumber => String(20) |
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
- The error code will be a string describing the error encountered. There is a wide range of possible errors, the most frequent of which are “No Answer”, “Busy”, and “No Remote Fax”
Examples
PHP using cURL
-
<?php
-
‘action’ => ‘Get_Fax_Outbox’,
-
‘access_id’ => ‘12345’,
-
‘access_pwd’ => ‘myPassword’,
-
‘sPeriod’ => ‘RANGE’,
-
‘sStartDate’ => ‘20150301’,
-
‘sEndDate’ => ‘20150331’
-
);
-
CURLOPT_POST => 1,
-
CURLOPT_HEADER => 0,
-
CURLOPT_URL => “https://secure.srfax.com/SRF_SecWebSvc.php”,
-
CURLOPT_FRESH_CONNECT => 1,
-
CURLOPT_RETURNTRANSFER => 1,
-
CURLOPT_FORBID_REUSE => 1,
-
CURLOPT_TIMEOUT => 60,
-
CURLOPT_SSL_VERIFYPEER => false,
-
CURLOPT_SSL_VERIFYHOST => 2,
-
);
-
}
-
else {
-
}
-
?>
PHP using SRFax Object
-
<?php
-
require_once (“srFax_class.php”);
-
$accountID = “12345”;
-
$accountPassword = “myPassword”;
-
// instantiate object with Account ID and Password
-
$srFax = new srFax ( $accountID, $accountPassword );
-
try {
-
‘sPeriod’ => ‘RANGE’,
-
‘sStartDate’ => ‘20150301’,
-
‘sEndDate’ => ‘20150331’,
-
));
-
}
-
catch (Exception $e) { //display error when exception is thrown
-
}
-
if ( $srFax->getRequestStatus () ) {
-
} else {
-
echo “ERROR: “ . $srFax->getRequestResponse ();
-
}
-
?>