Get Fax List
Get a list of recent outbound faxes (which does not include batch faxes).
GET /outbound/faxes[?limit={number}&lastId={number}&sortOrder={asc|desc}&userId={string}]
Arguments
Name (bold if mandatory) | Type | Comments | Default |
---|---|---|---|
limit | number | How many transactions to return. | 25 |
lastId | string | Return results from this ID onwards (not including this ID). Used for pagination. | Infinite when sortOrder is desc; zero when sortOrder is asc. |
sortOrder | string | asc or desc . Sorts by fax ID. |
desc |
userId | string | Enables a “primary” user to query for other account users’ faxes. | Current user (provided in credentials) |
Response
If successful, an array of outbound fax structures at a detail level of “full” is returned:
Property | Description | Detail Level | ||
---|---|---|---|---|
result | summary | full | ||
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 tde actual cost of the fax. | ✔ | ✔ | |
attemptsMade | Retry attempts actually performed. | ✔ | ✔ | |
pageSize | A4 , Letter , Legal , or B4 |
✔ | ||
pageOrientation | Portrait or Landscape |
✔ | ||
PageResolution | Standard or Fine |
✔ | ||
rendering | Standard (optimized for black & white) or Fine (optimized for grayscale) |
✔ | ||
pageHeader | The fax header text inserted at the top of the page. | ✔ | ||
submitTime | Time when the transaction was originally submitted. Always returned in GMT. |
✔ | ||
subject | A name or other optional identifier. | ✔ | ||
destinationFax | 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. | ✔ | ||
contact | The text which was inserted into the Contacts property upon submission of the fax (available in select submission methods only). | ✔ |
Sample Calls
Raw HTTP
GET /outbound/faxes HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Host: rest.interfax.net
cURL
Get fax list
curl "https://rest.interfax.net/outbound/faxes" ^
-u username:password
Get fax list. Limit to 10 results and order by asc
curl "https://rest.interfax.net/outbound/faxes?limit=10&sortOrder=asc" ^
-u username:password
Sample response (prettified for display here)
{
"isPrivate":false,
"listName":"mylistid",
"userID":"myuserid",
"numOfContacts":2
},
{
"isPrivate":false,
"listName":"mylistid",
"userID":"myuserid",
"numOfContacts":2
},