API Values for faxSendSubmit
| Parameters | Max Length | Description | Example |
| AccountID | Int(9) | Your Openfax Account ID. | 1008001 |
| APIKey | VarChar(255) | Generated API Key available in your portal. | IEYRtw2cd8aGa54 |
| FaxNumber | BigInt(20) | 11 Digit North American Fax Number. | 15555551212 |
| toHeader | VarChar(25) | Appears in the To: <Value> of fax header. | My Customer Name |
| frHeader | VarChar(25) | Appear in the Fr: <Value> of fax header. Note: It is a legal requirement that you accurately represent yourself or your company as the sender of this fax. |
My Company Name |
| paperSize | Int(1) | Specifies input PDF paper size for TIFF conversion:
0 – US Letter (8.5 x 11.0 in / 216 x 279 mm) 2 – A4 (8.5 x 11.0 in / 216 x 279 mm) |
0 |
| faxResolution | Int(1) | Fax resolution used for transmission:
Note: Fine mode may increase the documents transmission time. Depending on your pricing arrangement transmission times may impact the cost of the fax transmission. |
0 |
| Priority | VarChar(6) | Transactional faxing will always receive a higher priority on the Openfax network over other fax broadcast traffic. This affects how quickly your fax will be attempted in relation to other fax traffic on the network. It is recommended to always use “Normal”, though if your fax is less urgent you may Specify “Low” to give Normal transactional faxes preference over those specific with a Low priority. It is not possible to change a transactional fax priority once it has been submitted. Values are case sensitive. Normal – High transactional priorityLow – Lower transactional priority, other transactions will receive preference within the queue. |
Normal |
| PDF_encode | Base64 encoded | The PDF file is limited to 50MB max and should be base 64 encoded. | Limited to 50MB |
faxSendSubmit API Responses
| Response | Returns | Condition |
| Success | {
“Response”: “Success”, “OutTransID”: [id] |
Returns the OutTransID for the submitted outbound fax transaction. |
| Failed | {
“Response”: “Failed”, |
The total number attempted outbound FaxNumber transactions for the date range provided. |
| InvalidAuthentication | {
“Response”:”InvalidAuthentication” |
The account number or API key provided is invalid. |
| AccountInactive | {
“Response”:”AccountInactive” |
The account has reached the credit limit or has been deactivated, contact customer support. |
| RestrictedFaxNumber | }
“Response”:”RestrictedFaxNumber” |
The attempted number is restricted from dialing either due to the phone number owner’s request, compliance list or another reason. Contact customer support for details if required. |
| InvalidFaxNumberLength | {
“Response”:”InvalidFaxNumberLength” |
The FaxNumber is not valid for dialing. For North American dialing 1NPANXXXXX is required. International dialing is not supported at this time. |
| InvalidFaxResolution | {
“Response”:”InvalidFaxResolution” |
Specified faxResolution value is invalid. Value must be 0 for standard or 1 for fine resultion. |
| InvalidPapersize | {
“Response”:”InvalidPapersize” |
Specified paperSize value is invalid. Value must be 0 – US Letter, 1 – US Legal or 2 – A4. |
| InvalidPriority | {
“Response”:”InvalidPriority” |
Specified Priority value is invalid. Values are case sensitive and should be Normal or Low. |