Overview
This article gives instructions and parameters used when creating TextAPI files.
Solution
TextAPI Structure
When using TextAPI, create a text file (.txt format) that is structured as follows:
| Line | Description |
|---|---|
| First Line |
Specify the recipient's fax number preceded by a double colon, in the following format: For example: Other parameters can also be included in the following format:
For example, to send a fax to John Smith who is in the Sales department at company John Company and whose email address and fax number are
|
| Second Line (optional) |
Specify other sending options preceded by a double colon. Separate multiple parameters by commas.
|
| Other lines | Enter the message text to fax. |
TextAPI Sending Options/Parameters
- A number of sending options can be specified in the second line of the text API.
- Multiple options can be specified. Separate multiple parameters by commas.
For example:::s=subject,from=Peter,c=coverpage1,23:15,B=5 - GFI FaxMaker is not case-sensitive. Parameters can be specified in both capital or lowercase letters.
| Sending Options | Parameter | Description |
|---|---|---|
| Subject |
or
|
Specify the subject of the fax. This text is inserted in the <subject> field of the Coverpage. Replace This is the subject with the subject text. |
| Sender |
or
|
Use this parameter to specify the name of the fax sender. The name specified is included as the sender's name in the Coverpage. Replace NOTE: When this option is not specified, GFI FaxMaker has no information about the sender and therefore cannot return a transmission report via email. Instead, a response file is generated. For more information refer to TextAPI Response Files. |
| Attachment |
|
Specify a file to attach to the fax. The file must be stored in the same TextAPI pickup folder. Replace For example: Multiple files can be attached by specifying the command multiple times. For example: NOTE: Attachments are permanently removed from the pickup folder. If a copy is required, ensure that backup is taken before moving the attachment to the TextAPI folder. |
| Priority |
High priority
or
or
or
Low priority
or
or
or
|
Specify the fax priority (low or high) to use when sending the fax. |
| Billing Code |
or
|
Use this parameter to specify a billing code if GFI FaxMaker is configured to require a billing code. Replace nnnn with the billing code. |
| Schedule |
or
|
Specify the date and time, or time only when to send the fax. Replace:
For example, |
| Coverpage |
or
|
By default, GFI FaxMaker uses the default Coverpage configured in GFI FaxMaker. Use this parameter to send a fax using a particular Coverpage. Replace You can also use |
| Front Covernote |
or
|
Use this parameter to send a fax using a particular Front Covernote. Replace |
| Fax Line |
or
|
Specify this parameter to request the fax to be sent on a particular fax line. Replace NOTE: If the line is busy or unavailable, the fax is sent on another line. To send the fax strictly from a particular line, use the following parameter:
The fax is not sent until this fax line is available. NOTE: |
| Resolution |
High resolution
or
Normal resolution
or
|
Use this parameter to specify the resolution of the fax. Use high (200 * 200 dpi) or normal (200 * 100 dpi) resolution. |
| Header |
or
|
Use this option to set a custom personal header that is added to the default fax header at the top of the fax. Replace header with the header text to add. |
| Transmission Report Summary |
Send transmission report summary:
Never send a summary:
|
Use Use |
TextAPI Example:
::John, John's Company, Smith, Sales, sales@johnscompany.com, 12345678
::from=Bob Jones,subject=Hi John,H,fh=Test fax
This is the fax message.
Best regards,
Paul