Get list
Retrieves a user’s list of inbound faxes. (Sort order is always in descending ID).
Arguments
Name (bold if mandatory) | Type | Comments | Default |
---|---|---|---|
unreadOnly | Boolean | Return only unread faxes? | false |
limit | Number | How many transactions to return. | 25 |
lastId | Number | Return results from this ID onwards (not including this ID). Used for pagination. | Infinite |
allUsers | Boolean | For a “primary” user, determines whether to return data for the current user only or for all account users. | false |
Response
If successful, returns an array of the following structure:
Sample Call
Raw HTTP
GET /inbound/faxes?limit=10 HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Host: rest.interfax.net
cURL
Retrieves a user’s list of inbound faxes
curl "https://rest.interfax.net/inbound/faxes" ^
-u username:password
Retrieves a user’s list of unread inbound faxes
curl "https://rest.interfax.net/inbound/faxes?unreadOnly=true" ^
-u username:password
Return up to 10 results
curl "https://rest.interfax.net/inbound/faxes?limit=10" ^
-u username:password
Return results from this ID onwards.
curl "https://rest.interfax.net/inbound/faxes?lastId=229167854" ^
-u username:password
Sample response (prettified for display here)
{
"userId":"myuserid",
"messageId":229167854,
"phoneNumber":"8643137",
"remoteCSID":"INTERFAX",
"messageStatus":0,
"pages":1,
"messageSize":2495,
"messageType":1,
"receiveTime":"2012-06-23T17:23:13",
"callerId":"00001201",
"recordingDuration":24,
"imageStatus":"UNREAD",
"numOfEmails":1,
"numOfFailedEmails":0
}