GetFaxImage

Returns a TIF file of a transaction’s rendered document (fax image) for a given transaction ID.

Formal definition

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

Input

Name Type Comments
Username String The name of the user authenticating to the API
Password String The password for the Username
TransactionID Long The ID of the transaction for which the fax image is requested
Image ByRef Byte[] A reference to a byte array that will hold the image data of the fax

Output

Name Type Comments
GetFaxImageResult Long If retrieval of fax image is successful, return value is 0. In case of failure, a negative value is returned. See error codes below. See Web service return codes for a full list of return codes.
Image base64Binary The image data of the fax

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.
-1005 Transaction does not exist
-1009 Image not available (may happen if the ‘delete fax after completion’ feature is active)