The most feature-filled fax sending method. Allows full control over all aspects of fax transmission.
|Username||String||As provided during registration|
|Password||String||As provided during registration|
|FaxNumbers||String||A single fax number or a list of semicolon-separated fax numbers, e.g:
|Contacts||String||Semicolon-delimited list of names. The entered string will appear: (1) for reference in the outbound queue, and (2) in the outbound fax header. When faxing to a list managed online through your account, this field will be populated by the “Person Name” field in the list, or if unavailable, by the “Company Name” field in the list. Individual recipients and lists may be mixed.|
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.
If an uploaded file’s size is greater than 250KB, or if experiencing timeouts, consider using the Chunk Data Upload methods. If referencing a file uploaded by these methods (using its SessionID in parameter FileSizes below), this parameter is ignored. Send a zero-size buffer.
Note: Your development environment may automatically pick up this property’s data type and implicitly encode it in base64 without you needing to do so explicitly. For example, PHP5 does this.
|FileTypes||String||List of FileType, semicolon-separated, e.g:
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:
If the file(s) were uploaded with the Chunk Data Upload method, add the string
|Postpone||DateTime||Time to schedule the transmission. In case no scheduling is required (i.e. ASAP), use any date in the past, like
|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
|JobID||String||Reserved for future use|
|Subject||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.|
|ReplyAddress||String||One or more optional, semicolon-delimited e-mail addresses to which feedback messages will be sent. If null, the user’s default reply address (from the online control panel) is used.|
|SendfaxEx_2Result||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.