Usage report for a specified user and period

POST Variables

 

Variable Name Var Type Type Description
action String Required Must be “Get_Fax_Usage”
access_id Integer Required Account Number
access_pwd String Required Password on the user’s account
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” to include all usage by sub users of the account
sResponseFormat String Optional “XML” or “JSON” – Default is JSON

 

Notes:

  • If you want to use sIncludeSubUsers you must use the access_id and access_pwd of the Master Account
  • Usage values are only available for the current month

 

 

Returned Variables (JSON or XML Encoded)

 

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

array(
  UserID         => Integer,
  Period         => String, 
  ClientName     => String(50),
  SubUserID      => Integer,
  BillingNumber  => String(50),
  NumberOfFaxes  => Integer, 
  NumberOfPages  => Integer
)
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’     => ‘Get_Fax_Usage’,
  5.      ‘access_id’  => ‘12345’,
  6.      ‘access_pwd’ => ‘myPassword’,
  7.      ‘sPeriod’    => ‘RANGE’,
  8.      ‘sStartDate’ => ‘20150301’,
  9.      ‘sEndDate’   => ‘20150331’,
  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->Get_Fax_Usage(array(
  13.         ‘sPeriod’    => ‘RANGE’,
  14.         ‘sStartDate’ => ‘20150301’,
  15.         ‘sEndDate’   => ‘20150331’,
  17.       ));
  18.   }
  19.   catch (Exception $e) { //display error when exception is thrown
  20.       die(“Error: $e“);
  21.   }
  23.   if ( $srFax->getRequestStatus () ) {
  24.       echo “Success! Response “ . print_r($srFax->getRequestResponse (), 1);
  26.   } else {
  27.       echo “ERROR: “ . $srFax->getRequestResponse ();
  28.   }
  30. ?>