iFax API Quick Start Guide

Obtain Your API Key

  • Log in to your iFax Dashboard.
  • Navigate to Settings → Developer API to find your API key.

Send a Fax

Post
https://api.ifaxapp.com/v1/customer/fax-send
Name Value Description
Content-Type application/json API response will be in json format.
This header is required
Accept application/json The paramaters value should be passed in json format.
This header is required when passing json request
accessToken API key API key will be unique for all users. It is available in the settings page of your dashboard.
This header is required
Name Type Description
faxNumber String The receiptent fax number need to pass here.
This parameter is required
callerId String Caller ID will be used as From number.
templateId String You can get template ID from the Webapp. (optional)
subject String Subject will be used as subject on cover page.
from_name String From name will be used as Sender Name on cover page.
to_name String To name will be used as Recipient Name on cover page.
message String Message will be used as Comment on cover page.
send_at DateTime Provide a date and time in UTC format to schedule the fax delivery (optional)
faxQuality String Please select any option from the available choices (Low, Standard, HD). The default selection will be Standard.
faxData Array Array of attachment will be pass here. Allow pdf, doc & image attachment only
Required at least one attachment		 
	            	JSON Request 
	                {
	                  "faxNumber" : "+12345678901",
	                  "callerId" : "+12345678901",
	                  "templateId": "0000",
	                  "subject" : "test subject",
	                  "from_name" : "abc",
	                  "to_name" : "xyz",
	                  "message" : "sample fax",
	                  "send_at" : "2019-11-14T00:55:31.820Z",
	                  "faxQuality" :"Standard",
	                  "faxData" : [{
	                        "fileName" : "abc.pdf",
	                        "fileUrl" : "HTTP url of file",
	                        "pages": ["1-5","2", "1-10"]
	                      },
	                      {
	                        "fileName" : "xyz.pdf",
	                        "fileData" : "Base64 encoded string",
	                        "pages": ["1","2"]
	                  }]
	                }

Note: Replace the file URL with the direct link to your PDF document.

Check Fax Status

Post
https://api.ifaxapp.com/v1/customer/fax-status
Name Value Description
Content-Type application/json API response will be in json format.
This header is required
Accept application/json The parameters value should be passed in json format.
This header is required
accessToken API key API key will be unique for all users. It is available in the settings page of your dashboard.
This header is required
Name Type Description
jobId Integer It is a unique id generated when sending a fax. You will receive this from the Send Fax API response.
This field is required.		 
	              
	                {
	                  "jobId" : "12345"	                  
	                }

Note: Replace 12345 with the actual jobId received from the send fax response.

Receive Faxes via Callback

  • Set up a Receive Fax Callback URL in your iFax dashboard under Settings → Developer API → Webhooks.
  • Click Add Webhook.
  • iFax will POST received fax data to your callback URL
	              
	                {
	                  "direction": "inbound",
	                  "jobId": 7067845,
	                  "transactionId": 8660564,
	                  "faxCallLength": 127,
	                  "faxCallStart": 1745442509,
	                  "faxCallEnd": 1745442636,
	                  "faxTotalPages": 11,
	                  "faxReceivedPages": 11,
	                  "faxStatus": "received",
	                  "success": true,
	                  "fromNumber": "+2512445025",
	                  "toNumber": "+12096380085",
	                  "code": 0,
	                  "message": "NORMAL_CLEARING"	                  
	                }

Additional Features

  • Resend a Fax: POST /customer/fax-resend
  • Download Fax: POST /customer/fax-download
  • List Sent Faxes: POST /customer/fax-lists
  • Cancel Fax: POST /customer/fax-cancel

Refer to the iFax API Documentation for detailed information on these and other endpoints.

<