Description
This is the simplest method to fax a textual fax. Input is assumed to be UTF-8. Also allows structured text documents, such as HTML, PostScript, etc.
Formal Definition
https://ws.interfax.net/dfs.asmx?op=SendCharFax
Input
| Name |
Type |
Comments |
| Username |
String |
The name of the user authenticating to the API |
| Password |
String |
The password for the Username |
| FaxNumber |
String |
The destination fax number in standard international notation e.g. +44-207-3456789 (see Appendix B) |
| Data |
String |
Data of the document (text documents only, no binary content) |
| FileType |
String |
e.g. TXT, HTML, PS, etc. Default is TXT |
Output
| Name |
Type |
Comments |
| SendCharFaxResult |
Long |
In case of successful submission – the value contains the TransactionID. In case of a failure, a negative value is returned. See the Error Codes, below. List of return codes is shown on Appendix A. |
Error Codes
| Value |
Description |
| -111 |
Designated fax number does not match |
| -112 |
FaxNumber parameter is null or empty |
| -123 |
FileData parameter is null or the length of data byte array is 0 |
| -150 |
An exception occurs at any point in the execution of the web service method |
| -310 |
The logged in user in context is not a primary user |
| -666 |
The logged in user is configured in another switch group |
| -677 |
The logged in user does not have any TX service registered |
| -1002 |
The list of file types and document sizes do not match |
| -1003 |
The logged in user cannot be authenticated when either the username or the password is incorrect |
| -1004 |
The Filetype parameter is empty |
| -1007 |
The length of FileData parameter is empty after extracting bytes in UTF8 format from the data parameter as string |
| -1008 |
The total size and data passed in do not match |
| -1010 |
The Filetype parameter contains “/AB” & “/PB” switches making them ambiguous |
| -1011 |
Too many data requests from the Username |
| -1059 |
The list of file types separated by semi-colon “;” is greater than the maximum allowed attachments configured |
| -2003 |
The request from the IP of the machine is not in a valid IP address range |