This resource is used to send faxes through the etherFAX network to a destination fax number (or etherFAX endpoint).
The following parameters are supported when performing a POST operation to the outbox controller. If you are using the urlencoded form of this function (Content-Type: application/x-www-form-urlencoded), each parameter must be URL encoded in the post data associated with the HTTP request.
Remarks
After the POST operation, the etherFAX service will respond with an abbreviated FaxStatus response indicating whether the fax operation was successfully submitted to the etherFAX network. A FaxResult lt value of InProgress indicates that that the fax has been accepted and a unique identifier has been assigned to the event. All events within the etherFAX network have globally unique identifiers assigned for their lifetime. These are also known as GUIDs.
All fax images presented for transmission should conform to the TIFF-F minimum baseline (see TIFF specification). For best results, only submit fax images that are bi-tonal (black & white), have a standard fax width of 1728 pixels and are roughly 200x200 (fine) or 200x100 (coarse) dots per inch (resolution).
etherFAX also supports PDF and SENx (encrypted) documents.
Note, each etherFAX account is configured with a maximum number of ports (channels) to limit the number of outbound fax operations. If the number of active channels exceeds this configuration, the fax event will be rejected with a FaxResult value of NoChannelsAvailable.
- See FaxResult section for explanation of the FaxResult values.
Header Strings
The HeaderString parameter supports the following keywords and optional formatting:
| Keyword | Description |
|---|---|
| {date} | Shows current date adjusted to account's local time zone. |
| {date:format} | Shows current date adjusted to account's local time zone with optional formatting. |
| {time} | Shows current time adjusted to account's local time zone. |
| {time:format} | Shows current time adjusted to account's local time zone with optional formatting. |
| {utcdate} | Shows the current date in UTC. |
| {utcdate:format} | Shows the current date in UTC with optional formatting. |
| {utctime} | Shows the current time in UTC |
| {utctime:format} | Shows the current time in UTC with optional formatting. |
| {csid} {from} | Shows the sender CSID's (Call Subscriber Identification) information. |
| {number} {to} | Shows the destination fax number. |
| {page} | Shows the current page number. |
| {pages} | Shows the current page number and total pages in fax. This is equivalent to using: "{page} / {total}" |
| {total} | Shows the total page count. |
Default header used by etherFAX:
Example:
" {date} {time} FROM: {csid} TO: {number} P. {page}"
Output:
" 05/06/2014 08:46 AM FROM: etherFAX, LLC TO: +18005551234 P. 1"
Example using date formatting:
Example:
" {date:d-MMM-yyyy} {time} FROM: {csid} TO: {number} P. {page}"
Output:
" 6-May-2014 08:46 AM FROM: etherFAX, LLC TO: +18005551234 P. 1"
Note: It is best to leave 2 spaces at the beginning of the header string to avoid the header starting too close to the left edge of the page.