als_send_fax.cgi

Top Previous Next

Description

The als_send_fax.cgi interface enables html faxing and requires the AL-Pro Fax Server be available.

Example Usage

http://www.alswebportal.com:88/als_send_fax.cgi?phone=808-333-2322&file=voucher3443.htm&webusercode=1

Description of Required Inputs

A webusercode:Integer must be included that represents the Web Interface user code supplied to you by your Activity Link System Administrator.

A phone number as a string is required.

the als_send_fax.cgi method supports HTML documents or plain text files. In order to deliver the html document to be processed you can define a file or a url

If you use a url, you do not include the http prefix as in this example.

http://www.alswebportal.com:88/als_send_fax.cgi?phone=808-333-2322&url=www.alswebportal.com:88/voucher3443.htm&webusercode=1

If you use a file, that file must be available on the server using the server root directory as the base.

Returned Information

Upon successful use of this method you will be returned a FAXID along with the phone number and either the URL or file. You will also see the size of the html file that was processed. The FaxID is used by the AL-Pro Fax Server as an identifier of the fax job being processed. AL-Pro itself has FAX options to resend faxes.

Inputs

Parameter	Description	Required	Example	Data Type
webusercode	Code from WiUsers required for insert access	Required	webusercode=1	Integer
phone	fax phone number including area code	Required	phone=212-389-3212	String
file	Master Content Name from als_get_content.cgi	Optional	name=directions	String
url	Active Items only	Optional	active=true	String

Returned Fields

#	Field Name	Description	Data Type

XML Returned

File Example

<root>

<data>

</data>

</root>

URL Example

<root>

<data>

</data>

</root>