Get list

Retrieves a user’s list of inbound faxes. (Sort order is always in descending ID).

GET /inbound/faxes[?unreadOnly={boolean}&limit={number}&offset={number}&allUsers={boolean}&lastId={number}]


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


If successful, returns an array of the following structure:

Name Type Description
userId String The username that received this transaction
messageId Integer The internal ID assigned for this transaction
phoneNumber String The Phone number at which this fax was received
remoteCSID String The CSID of the sender
messageStatus Integer Status of the fax. See the list of InterFAX Error Codes
Pages Integer The number of pages received in this fax.
messageSize Integer The size of the inbound fax image (in bytes)
messageType Integer The type of message. Currently sends out static ‘1’.
receiveTime DateTime The time and date that the fax was received
(formatted as dd/MM/yyyy hh:mm:ss). Times listed are GMT.
callerId String The caller ID of the sender
recordingDuration Integer The time (in seconds) that it took to receive the fax
imageStatus String Indicates the status of the fax image – possible values are “UNREAD”, “READ” and “DONT_EXIST”
numOfEmails Integer The number of email address that this fax should have been sent to once received
numOfFailedEmails Integer The number of email addresses that had failed delivery of the fax by email

Sample Call


GET /inbound/faxes?limit=10 HTTP/1.1
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=


Retrieves a user’s list of inbound faxes

curl "" ^
	-u username:password

Retrieves a user’s list of unread inbound faxes

curl "" ^
	-u username:password

Return up to 10 results

curl "" ^
	-u username:password

Return results from this ID onwards.

curl "" ^
	-u username:password

Sample response (prettified for display here)