The following operations are available within the GoFax® RestFUL fax API.
Fax API Calls
The following operations are available within the GoFax® RestFUL fax API.
How to integrate GoFax® into your business applications & tools
Step 1
Register with GoFax®
Sign up and purchase GoFax® Send Credits.
Step 2
Create Token
Create a login token using your master user account.
Step 3
Start Testing
Test operations of the GoFax® Fax API.
Step 4
Connect
Launch and enjoy the GoFax® advantage.
GoFax® Trusted by Businesses
Business grade online fax and SMS communications solutions powering the Medical, Legal, Government, Corporate industries and more. We’ve successfully intgrated with software platforms across industries to provide a completely customised solution.
| Account_GetDetails | Get account details |
| Account_CreditBalance | Get a Recent Vaild Token Created on the account |
| Account_GetToken | Get a Recent Vaild Token Created on the account |
| Account_CheckHaveAccess | Check GoFax system accessibility using your token. Returns ‘true‘, if access is permitted; returns ‘false’ otherwise. |
| SendFaxV_Status | Get a single fax status based on faxId. |
| SendFaxV_FaxDocument | Get Document / Fax details like page count, fax charges, fax status, timestamp based on faxId. |
| SendFaxV_FaxDocumentData | Get Send Fax Document in PDF or TIFF formats |
| SendFaxV_Send | Send Faxes to one of more fax numbers using this API call. Allows you to specify the Sender ID, Fax Headers, Scheduled Time, High Quality and ClientReference for reporting purpose |
| SendFaxV_Cancel | This call is used to cancel an outgoing fax. Cancellation of a fax can only occur when the transmission has not yet started, e.g. Initialised, Conversion in Progress, Queued for Transmission |
| SendFaxV_Resend | This call can be used to resend an unsuccessfully sent fax. |
| ReceiveFaxesV_GetDetails | Get Received Fax details for all Fax Numbers on the account |
| ReceiveFaxesV_GetActiveFaxNumbers | Get the list of active Fax Number/s on the account |
| ReceiveFaxesV_GetDetailsByLimit | Get the list of Received Faxes on a Single Fax Number |
| ReceiveFaxesV_UnretrievedFaxes | Get the list of Received Faxes that have not been retreived. |
| ReceiveFaxV_GetSettings | Get details for the Push URL set up on the account for Fax Receive |
| ReceiveFaxV_PutSettings | Update the Push URL on the account for Fax Receive |
| ReceiveFaxV_FaxDocument | This call returns the specific fax document received in PDF/TIFF format |
| ReceiveFaxV_MarkRetrievedFax | Update a Single Fax as IsRetrieved on the account |
| SystemV_LegalTypes | Get the list of supported file formats for Fax Send Description |
- Account
-
Account_GetDetails Get account details Account_CreditBalance Get a Recent Vaild Token Created on the account Account_GetToken Get a Recent Vaild Token Created on the account Account_CheckHaveAccess Check GoFax system accessibility using your token. Returns ‘true‘, if access is permitted; returns ‘false’ otherwise. - Send Faxes
-
SendFaxV_Status Get a single fax status based on faxId. SendFaxV_FaxDocument Get Document / Fax details like page count, fax charges, fax status, timestamp based on faxId. SendFaxV_FaxDocumentData Get Send Fax Document in PDF or TIFF formats SendFaxV_Send Send Faxes to one of more fax numbers using this API call. Allows you to specify the Sender ID, Fax Headers, Scheduled Time, High Quality and ClientReference for reporting purpose SendFaxV_Cancel This call is used to cancel an outgoing fax. Cancellation of a fax can only occur when the transmission has not yet started, e.g. Initialised, Conversion in Progress, Queued for Transmission SendFaxV_Resend This call can be used to resend an unsuccessfully sent fax. - Receive Faxes
-
ReceiveFaxesV_GetDetails Get Received Fax details for all Fax Numbers on the account ReceiveFaxesV_GetActiveFaxNumbers Get the list of active Fax Number/s on the account ReceiveFaxesV_GetDetailsByLimit Get the list of Received Faxes on a Single Fax Number ReceiveFaxesV_UnretrievedFaxes Get the list of Received Faxes that have not been retreived. ReceiveFaxV_GetSettings Get details for the Push URL set up on the account for Fax Receive ReceiveFaxV_PutSettings Update the Push URL on the account for Fax Receive ReceiveFaxV_FaxDocument This call returns the specific fax document received in PDF/TIFF format ReceiveFaxV_MarkRetrievedFax Update a Single Fax as IsRetrieved on the account - System
-
SystemV_LegalTypes Get the list of supported file formats for Fax Send Description
Australian based support
Integrate all functionality of a dedicated virtual fax or SMS platform into your software using API GoFax®. Australia’s Only GITC government accredited and HIPAA compliant solution.
Australian based support
Integrate all functionality of a dedicated virtual fax or SMS platform into your software using API GoFax®. Australia’s Only GITC government accredited and HIPAA compliant solution.