Get fax record

Retrieves information regarding a previously-submitted fax, including its current status.

GET /outbound/faxes/{id}

Arguments

Name (bold if mandatory) Type Comments Default
id Number The transaction ID of the fax for which to retrieve data. None, mandatory.

Response

If successful, an outbound fax structure is returned:

Property Description
id A unique identifier for the fax.
uri A unique resource locator for the fax.
status Fax status. Generally, 0= OK; less than 0 = in process; greater than 0 = Error (See Interfax Status Codes)
userID The submitting user.
pagesSent Number of successfully sent pages.
completionTime End time of last of all transmission attempts.
remoteCSID Receiving party fax ID (up to 20 characters).
duration Transmission time in seconds.
priority For internal use.
units Decimal number of units to be billed (pages or tenths of minutes)
costPerUnit Monetary units, in account currency. Multiply this by 'Units' to get the actual cost of the fax.
attemptsMade Retry attempts actually performed.
pageSize a4, letter, legal, or b4
pageOrientation portrait or landscape
resolution standard or fine
rendering greyscale or bw
pageHeader The fax header text inserted at the top of the page.
submitTime Time when the transaction was originally submitted. Always returned in GMT.
reference A name or other optional identifier.
faxNumber The resolved fax number to which the fax was sent.
replyEmail E-mail address for confirmation message.
pagesSubmitted Total number of pages submitted.
senderCSID Sender's fax ID.
attemptsToPerform Maximum number of transmission attempts requested in case of fax transmission failure.

Samples


GET /outbound/faxes/279415116 HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Host: rest.interfax.net

Sample response (prettified for display here)


{
   "submitTime":"2012-06-20T06:08:18",
   "contact":"",
   "destinationFax":"0081287282867",
   "replyEmail":"nadya@interfax.net",
   "subject":"test",
   "pagesSubmitted":1,
   "senderCSID":"INTERFAX",
   "attemptsToPerform":4,
   "pageSize":"A4",
   "resolution":"Portrait",
   "pageResolution":"Fine",
   "pageOrientation":"Portrait",
   "rendering":"Fine",
   "pageHeade":"0",
   "userId":"nadya",
   "pagesSent":1,
   "completionTime":"2012-06-20T06:09:08",
   "remoteCSID":"81287282867",
   "duration":37,
   "priority":2,
   "units":1.00,
   "costPerUnit":0.9500,
   "attemptsMade":1,
   "id":279415116,
   "uri":"https://rest.interfax.net/outbound/faxes/279415116",
   "status":0
}

curl "https://rest.interfax.net/outbound/faxes/279415116" ^
    -u username:password

Sample response (prettified for display here)


{
   "submitTime":"2012-06-20T06:08:18",
   "contact":"",
   "destinationFax":"0081287282867",
   "replyEmail":"nadya@interfax.net",
   "subject":"test",
   "pagesSubmitted":1,
   "senderCSID":"INTERFAX",
   "attemptsToPerform":4,
   "pageSize":"A4",
   "resolution":"Portrait",
   "pageResolution":"Fine",
   "pageOrientation":"Portrait",
   "rendering":"Fine",
   "pageHeade":"0",
   "userId":"nadya",
   "pagesSent":1,
   "completionTime":"2012-06-20T06:09:08",
   "remoteCSID":"81287282867",
   "duration":37,
   "priority":2,
   "units":1.00,
   "costPerUnit":0.9500,
   "attemptsMade":1,
   "id":279415116,
   "uri":"https://rest.interfax.net/outbound/faxes/279415116",
   "status":0
}

Contact us today

Talk to a member of our team about the benefits InterFAX can bring to your organization's communications processes.

Contact us today