Search fax list
Search for outbound faxes.
Note: this operation will return individual faxes (i.e., /faxes resources) as well as child faxes of batches (i.e., /batches/{id}/children resources).
Arguments
Name (bold if mandatory) | Type | Comments | Default |
---|---|---|---|
ids | List of numbers | List of comma-delimited fax IDs | None |
reference | String | The ‘reference’ parameter entered at submit time | None |
dateFrom | Datetime | Lower bound of date range from which to return faxes | No limit |
dateTo | Datetime | Upper bound of date range frrom which to return faxes | No limit |
status | String | May be a specific value from the list of possible fax status codes or one of the following: Completed = return only completed faxes, whether successful or failed, Success = return only successfully-completed faxes, Failed = return only failed faxes, Inprocess = return only faxes in process, All = return faxes of any status. |
All |
userId | List of string | Limit returned faxes to these user ID’s. This parameter has effect only when the querying username is a “primary” user. | None |
faxNumber | Faxnumber | Limit returned faxes to this destination fax number. | None |
limit | Number | How many transactions to return. | 25 |
offset | Number | Skip this many records | 0 |
Response
If successful, an array of outbound fax structures at a detail level of “full” is returned:
Sample Calls
Raw HTTP
GET /outbound/search?status=Inprocess HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Host: rest.interfax.net
cURL
Search fax list with status “In process”
curl "https://rest.interfax.net/outbound/search?status=Inprocess" ^
-u username:password
Search fax list. Limit to 2 results and skip 20 records each time
curl "https://rest.interfax.net/outbound/search?limit=2&offset=20" ^
-u username:password
Sample response (prettified for display here)
{
"submitTime":"2012-06-23T17:25:49",
"contact":"",
"destinationFax":"0012345678910",
"replyEmail":"youremail@domainaddress.net",
"subject":"test",
"pagesSubmitted":1,
"senderCSID":"INTERFAX",
"attemptsToPerform":4,
"pageSize":"A4",
"resolution":"Portrait",
"pageResolution":"Fine",
"pageOrientation":"Portrait",
"rendering":"Fine",
"pageHeader":"0",
"userId":"youruser",
"pagesSent":0,
"completionTime":"0001-01-01T00:00:00",
"remoteCSID":"",
"duration":0,
"priority":2,
"units":0.0,
"costPerUnit":0.5000,
"attemptsMade":0,
"id":ID (Numeric),
"uri":"https://rest.interfax.net/outbound/faxes/ID",
"status":-3
}