Get batch list
Retrieve a list of outbound batches.
GET /outbound/batches[?lastId={number}&limit={number}&sortOrder={asc|desc}&allUsers={true|false}]
Arguments
| Name (bold if mandatory) |
Type | Comments | Default |
|---|---|---|---|
| lastId | Number | Return results from this ID onwards (not including this ID). Used for pagination. | |
| limit | Number | How many transactions to return. | 25 |
| sortOrder | String | asc or desc. |
desc |
| allUsers | Boolean | Return results for all accounts users (or for current user only)? | false |
Response
If successful, an array of outbound fax structure is returned that includes the following properties:
| Name | Type | Description |
|---|---|---|
| batchHeadId | Number | Unique identifier for the batch. |
| userId | String | The submitting user. |
| numOfTransactions | Number | Number of child faxes in batch |
| submitTime | DateTime | Submission time of the batch |
| replyEmail | E-mail address for confirmation message. | |
| reference | String | A name or other optional identifier. |
| pagesSubmitted | Number | Total number of pages submitted. |
| senderCSID | String | Sender’s fax ID. |
| pageSize | String | A4, Letter, Legal, or B4 |
| pageOrientation | String | Portrait or Landscape |
| pageResolution | String | Standard or Fine |
| renderingQuality | String | Standard (optimize for black & white) or Fine (optimize for grayscale) |
| pageHeader | String | The fax header text inserted at the top of the page. |
| attemptsToPerform | Number | Maximum number of transmission attempts requested in case of fax transmission failure. |
Sample Calls
Raw HTTP
GET /outbound/batches?limit=10&sortOrder=asc HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Host: rest.interfax.net
cURL
Return up to 10 results and sort by asc
curl "https://rest.interfax.net/outbound/batches?limit=10&sortOrder=asc" ^
-u username:password
Return batches for all users in the account
curl "https://rest.interfax.net/outbound/batches?allUsers=true" ^
-u username:password
Sample response (prettified for display here)
{
"batchHeadId":221386922,
"userId":"myuserid",
"numOfTransactions":4,
"submitTime":"2011-07-21T13:39:17",
"replyEmail":"user@interfax.net",
"reference":"FW: TEST",
"pagesSubmitted":1,
"senderCSID":"INTERFAX",
"pageSize":"A4",
"pageOrientation":"Portrait",
"pageResolution":"Fine",
"renderingQuality":"Fine",
"pageHeader":"0",
"attemptsToPerform":4
},