FaxStatus

Returns quick and minimal information (11 fields) regarding a fax transaction’s current status.

Note: This method is rate-limited, as defined in System limitations.

Formal definition

https://ws.interfax.net/dfs.asmx?op=FaxStatus

Input

Name	Type	Comments
Username	String	The name of the user authenticating to the API
Password	String	The password for the username
LastTransactionID	Integer	Messages with TransactionIDs smaller than this parameter will be retrieved. The method will start retrieving fax transactions from the most recent TransactionID that is less than the provided LastTransactionID.For example, to query transaction ‘N’, enter ‘N+1’ for this property and ‘1’ for MaxItems below. To retrieve all transactions – use ‘999999999’. Using this, it is possible to obtain the latest transaction quickly and display it. Afterwards, more data may be obtained concurrently with previously returned displays of data.
MaxItems	Integer	Maximum number of FaxItem elements to be retrieved
TotalCount	Integer	Parameter to hold the returned total number of transactions
ListSize	Integer	Parameter to hold the size of the returned list
ResultCode	Integer	Parameter to hold the returned result code

Output

Name		Type	Comments
FaxStatusResult		Structure	Returns details of fax transactions.
	TotalCount	Integer	An output parameter – total number of transactions for this user (regardless of number of transactions returned).
	ListSize	Integer	An output parameter – total number of transactions actually returned by the query (size of FaxItems array).
	ResultCode	Integer	The result code of the operation. See error codes below. See Web service return codes for a full list of return codes.
	FaxItems	Array of FaxItem	Details of fax transactions. See FaxItem definition.

FaxItem definition

Name	Type	Comments
TransactionID	Integer	The ID of the fax transaction
SubmitTime	DateTime	The time when the transaction was originally submitted by the client
PostponeTime	DateTime	The time to which transmission was scheduled. Returns '0000-00-00' if not postponed
CompletionTime	DateTime	End time of last of all transmission attempts
DestinationFax	String	The fax number in a canonical format (see Appendix B)
RemoteCSID	String	Receiving party’s CSID (up to 20 characters)
PagesSent	Short	Number of successfully sent pages
Status	Integer	Fax status. 0= OK; greater than 0 = Error. See Fax status codes for a list of return codes.
Duration	Integer	The duration of the fax transmission in seconds
Subject	String	The subject of the fax as originally submitted
PagesSubmitted	Short	Number of pages originally submitted

Error codes

Value	Description
-150	Internal System Error. An exception occurred at any point in the execution of the web service method.
-1003	Authentication error: the user cannot be authenticated when either the username or the password is incorrect OR any other last error occurred when authenticating the user.
-1011	Too many data requests from the Username. (The maximum frequency of polling for fax status is defined under System limitations.)