For AI agents: visit https://docs.etherfax.net/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
etherFAX REST APIAPI Reference
HomeGuidesAPI ReferenceChangelog
v3.0

API ReferenceLog InetherFAX REST API
API Reference
Log In
v3.0

etherFAX REST API 3.0

  • Introduction
  • Authentication

ACCOUNTS

  • /accountsget
  • /accounts/pkinfopost

OUTBOX

  • /outboxpost
  • /outbox (pending)get

INBOX

  • /inbox (unread)get
  • /inbox (list)get
  • /inbox (get)get
  • /inbox (getnext)get
  • /inbox (received)get

STATUS

  • /statusget
  • /statuspost

ROUTES

  • /routes (info)get
  • /routes (list)get
  • /routes (parse)get
  • /routes (enable | disable)get

DEVICES

  • /devices (unread)get
  • /devices (list)get
  • /devices (status)get
  • /devices (actionreset)get
  • /devices (setaddr)get
  • /devices (setconfig)get
  • /devices (register)get
  • /devices/pkinfopost

MODELS

  • DeviceActions
  • DeviceEnrollment
  • DeviceEnrollmentResult
  • FaxAccount
  • FaxDevice
  • FaxReceive (DocumentParams)
  • FaxResult
  • FaxSend
  • FaxSendOptions
  • FaxState
  • FaxStatus
  • PendingFaxResult
  • RouteInfo (EncryptionParams)
  • TransactionType
  • UnreadFaxResult

FORMS RECOGNIZER

  • AnalyzeFormResult
  • AnalyzeResult
  • DocumentResultsItem
  • PageResultsItem
  • ReadResultsItem
Powered by 

FaxState

Indicates the state of the fax event.

/// <summary>
/// FaxState values.
/// </summary>
public enum FaxState
{
	Idle = 0,
	Initializing,
	Dialing,
	Answering,
	Negotiating,
	Sending,
	Receiving,
	Cancelling,
	Disconnecting,
	Conversion
}

Updated about 1 year ago


FaxSendOptions
FaxStatus

Updated about 1 year ago


FaxSendOptions
FaxStatus