SendfaxEx
Description
[Retained for backward-compatibility; replaced by SendfaxEx_2]
Formal Definition
https://ws.interfax.net/dfs.asmx?op=SendfaxEx
Input
Please note that this method is retained for backward-compatibility only. We encourage new development to use the SendfaxEx_2
method.
Parameters:
Name | Type | Comments |
---|---|---|
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: 1-212-3456789;+44161-999 . Maximum number of fax numbers: 500.If multiple fax numbers are provided, multiple transactions with consecutive TransactionID’s will be created. All such transactions will share a single ParentTransactionID, whose value is the TransactionID of the FIRST transaction in the batch. |
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. 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. |
FileTypes | String | List of FileType, semicolon-separated, e.g:DOC;HTML;HTML . Number of items in the list should match number of documents, even if all documents are of the same type. |
FileSizes | String | List of numbers, semicolon-separated, each defining the length of a document. Example: 12034;8888;18478 If the file(s) were uploaded with the Chunk Data Upload method, add the string /sessionID=[session ID] . The SessionID is the one returned by the StartFileUpload call. Example: 12034;8888;18478/sessionID=123456 |
Postpone | DateTime | Time to schedule the transmission. In case no scheduling is required (i.e. ASAP), use any date in the past, like '2000-01-01' . |
IsHighResolution | Boolean | True ==> Fine, False ==> Standard. True renders documents more finely but takes longer to transmit (may therefore be more costly). |
CSID | String | Sender CSID (up to 20 characters). If not provided, user’s default CSID is used. |
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 | An optional e-mail address to which feedback messages will be sent. If not provided, user’s default reply address is used. |
Output
Name | Type | Comments |
---|---|---|
SendfaxExResult | 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. |