GetList

Description

This method enables the retrieval of a list of received faxes.

Note that this method is rate-limited, as defined under System Limitations

Formal Definition

https://ws.interfax.net/inbound.asmx?op=GetList

Input

Name Type Comments
Username String As provided during registration
Password String As provided during registration
LType ListType Inbound.ListType – Enumeration: AllMessages = return all messages for this user; NewMessages = return only new messages for this user; AccountAllMessages = return all messages for all users under account (username used above must be defined as administrator in the account); AccountNewMessages= return new messages for all users under account (username used above must be defined as administrator in the account).
MaxItems Integer Maximum items to return, between 1 to 100

Output

Name Type Comments
GetListResult Integer 0 – OK
< 0 – Error, see Appendix A
MessageItem Array Output parameter: array of MessageItem.NOTE: Items in the inbound queue are returned by the GetList method ONLY if the image associated with them is still available on the Interfax server. Fax images are kept for a number of days documented in the “Inbound Service” section of System Limitations.

MessageItem Definition

Name Type Comments
MessageID Integer Message ID number
PhoneNumber String Interfax phone number
RemoteCSID String Sending party CSID (up to 20 characters)
MessageStatus Integer 0 = OK
> 0 = Error, see Interfax Error Codes
Pages Integer Number of pages
MessageSize Integer Message size in bytes (this is the size of the message as received by the fax server, before any further processing. Do not use this size in GET fax image methods
MessageType Short Currently 1 constant
ReceiveTime DateTime Time of fax reception
CallerID String Sender phone number, if Caller ID available
MessageRecordingDuration Integer Duration of inbound fax in seconds