SendfaxEx_3

Description

Allows more control over fax transmission aspects. This is a Secure Lounge method. In case you are not a Secure Lounge client click here

formal definition

https://ws-sl.fax.tc/Outbound.asmx?op=SendFaxEx_3

Input

Name Type Comments
Username String As provided during registration
Password String As provided during registration
FaxNumber String
Contact String The text which was inserted into the Contact property upon submission of the fax.
FilesData base64Binary Binary data of the document(s). If two or more documents are uploaded, concatenate their binary data.
The total length of this parameter is the sum of all items in the FileSizes parameter.
FileTypes String List of FileType, semicolon-separated, e.g:TXT;DOC;HTML;HTML.
The number of items in this list should match the number of documents, even if all documents are of the same type. Can be any one of the file types supported by InterFAX. (If TXT, the character set is taken from control panel setting Preferences -> Outgoing -> Default text charset encoding.)
FileSizes String List of numbers, semicolon-separated, each defining the length of a document (before base64-encoding).Example: 12034;8888;18478
RetriesToPerform Integer Number of transmission attempts to perform, in case of fax transmission failure. The minimum interval between two subsequent attempts is set through your account defaults.
CSID String Sender CSID (up to 20 characters). If not provided, user’s default CSID is used.
PageHeader String The fax header text to insert at the top of the page. Enter a string template to send a fax with a dynamically-populated header. For placeholder documentation, see your online settings under Preferences -> Outgoing -> Header Properties. For example, in the string To: {To} From: {From} Pages: {TotalPages} the placeholders {To}, {From}, and {Pages} will be populated by their respective values.Alternatively, enter Y or a null string to send the fax with a constant header that is defined in your online preferences above or N to send the fax without a header.
Reference String Up to 60 characters, to be used as a reference only. The Subject parameter can be obtained by status query, but is not included in the transmitted fax message.
PageSize String A4LetterLegal, or B4. If not provided, user’s default page size is used. Add -fit to fit (enlarge or reduce) an image file to a certain page size, e.g. A4-fit.
PageOrientation String Portrait or Landscape. If not provided, user’s default page orientation is used.
IsHighResolution Boolean True ==> Fine, False ==> Standard. True renders documents more finely but takes longer to transmit (may therefore be more costly).
IsFineRendering Boolean True ==> Optimize for greyscale, False ==> Optimize for B&W. “False” is recommended for textual, black & white documents, while “True” is better for greyscale text and for images.
UserData String Reserved for future use
JobID String Reserved for future use

Output

Name Type Comments
SendfaxEx_3Result Long In case of successful submission – the value contains a Transaction ID.
In case of a failure, a negative value is returned. List of return codes is shown on Appendix A.