Users Guide – Easylink SendFax Web Service v1.0
What’s in this release?
This release is contained in a zip that will install on a Windows box. Extract the setup.exe file that is contained in the zip archive. Run the setup.exe and install the application in any directory. This install will create the following directories
\bin – Contains the complied executables that were created from the source to run the standard fax functions
\Source – Contains source files that were used to main(ELSManager) and the proxy(SOAPService) classes.
\Source\test – Contains the sample code that was used to create the Test* executables.
\Test – Sample data for faxing
\Docs – Documentation
Installation
In order to run the sample applications, .NET Framework v2.0 must be installed for API to work.
To install the Easylink SendFax Web Service .NET sample API, first download the installation zip package from Easylink’s developer section of the web site.
Unzip the file into your local
development environment in any temporary directory and double click on
setup.exe
Running the Samples
The .NET sample API package comes with a number of pre-built samples that you can use for testing. The source code for the samples are contained in the \source\test directory. The samples use the classes (ESLManager and SOAPService) that were created with the source in \source directory. All the source code was developed in .NET VB.
To run the samples all you need to do is navigate to the \bin folder. Contained in this folder are scripts for running the four sample applications.
· TestSendFax.exe – Send a fax through the easylink. Network
· ResendFax.exe – Resend a fax already sent with SendFax
· TestKillFax.exe – Terminate a fax that is waiting to be sent
· TestQueryFax.exe – Query the Status of a fax on the Easylink Network
![Text Box: TestSendFax – Send a fax to the destination
Usage : testsendfax /h:<host> /p:<Port> -/e:<EmailAddress> /P:<Password> /d:<Destination number> /f:<full path of document to send> [options]
Parameters:
/h: – The Host Name of the destination service.
/p: – The Port of the destination service. , ie 443 unless using a proxy.
/e: – The Email Address of the registered account
/P: – Password for the registered account
/d: – Destination fax number
/f: – full filepath of file(s) to be faxed to destination. There must be at least one. Separate multiple files with a semi-colon ;
Options:
/t: – TSI The Optional Fax Server Identification String
/a: – Alternative delivery E-mail address
/to: – To String value
/A: – Account Code for tracking the fax 16 digits max
/u: - Unique User Code for tracking the fax 20 Char max
Example:
TestSendFax /h:webservicestest.easylink.com /p:443 /e:mytest@acme.com /P:passwd /d:15557415335 /u:12121212 /f:c:\netsoa\test\TestFax.txt](usersguide_files/image001.gif)
Samples
The source code for the test sample applications are contained in the \source\test folder. There are VB .Net files in this folder for each of the sample applications.
The sample applications are wrappers for the ELSManager object. These samples take the command line parameters and pass them into the ELSManager and invoke the appropriate call. You can look at the source code for these samples as an example of how to instantiate and invoke the ELSManager object.
Using ELSManager
SendFax is a Web Service that is available on the Internet for sending faxes from your application. To make it easier to use Easylink has packaged up the capabilities of the web service in a manager, ELSManager.dll. The source code for this manager can be viewed in \source\ELSManager.vb.
Using ELSFaxManager is very simple. All that is needed is to instantiate an instance of ELSManager, set the host, port, registered email address and password then invoke the appropriate method call.
![Text Box: Main methods:
- Public Function sendFax(ByVal destination As String, _
ByVal accountCode As String, _
ByVal userCode As String, _
ByVal tsi As String, _
ByVal alternateDeliveryNotice As String, _
ByVal deliveryNoticeType As String, _
ByVal faxResolution As String, _
ByVal [to] As String, _
ByVal from As String, _
ByVal attachments As List(Of System.IO.FileInfo)) As String
‘Returns Transaction_ID
‘getFaxdatafiles function returns array of Data type
- Public Function KillFaxResponse(ByVal userCode As String) As String
‘Returns Status. Empty if operation comleted successfully
- Public Function resendFaxResponse(ByVal userCode As String, ByVal destination As String)
As String
‘Returns Status.
- Public Function queryFax(ByVal userCode As String) As QueryFaxResponse
Data - class containing data of a file and its type
QueryFaxRequest - class of inquiry for a fax status
ELSException – class throws exception](usersguide_files/image005.gif)
When connecting the SendFax service you must use the appropriate host and port. The Easylink service supports the following connections:
webservicetest.easylink.com:443 - Test system secured fax endpoint
faxadmin.easylink.com:443 - Secured production fax endpoint
File Attachments
ELSManager.sendFax(…) requires at least one file attachment as the content to be faxed. These attachments can be any file type supported by the Easylink network. Please refer to Easylink FAQ for the supported types.
Running over a secure
connection
In a production environment Easylink requires that you connect to a secured endpoint. This means that you will need to set your port to 443