FaxReceive (DocumentParams)

Each received fax contains a DocumentParams section showing the type of fax content received, its length and the md5 hash of the binary contents.

The Type field is represented as an application mime-type:

• "image/tiff"
• "application/pdf"
• "application/x-senx"

/// <summary>
/// DocumentParams class.
/// </summary>
public class DocumentParams
{
	public string Type { get; set; }
	public int Length { get; set; }
	public string Hash { get; set; }
	public string Name { get; set; }
}

In the latest version of the REST API, TransactionType and DocumentParams have been added to the FaxReceive structure. When querying received faxes from the inbox, this additional information provides further details about the received content.

📘

Forms Recognizer

Accounts using etherFAX.AI (Forms Recognizer) services may now retrieve all OCR results, page results, and document extraction results from the FaxReceive class. See the Forms Recognizer section for information layout details.

/// <summary>
/// FaxReceive class.
/// </summary>
public class FaxReceive
{
	public FaxResult FaxResult { get; set; }
	public Guid JobId { get; set; }
	public string CalledNumber { get; set; }
	public string CallingNumber { get; set; }
	public string RemoteId { get; set; }
	public int PagesReceived { get; set; }
	public int ConnectTime { get; set; }
	public int ConnectSpeed { get; set; }
	public DateTime ReceivedOn { get; set; }
	public byte[] FaxImage { get; set; }
	public int DeviceId { get; set; }
	public TransactionType TransactionType { get; set; }
	public DocumentParams DocumentParams { get; set; }
	public AnalyzeFormResult AnalyzeFormResult { get; set; }
}