The following operations are available within the GoFax® RESTful fax API.
GoFax RESTful API for Fax & SMS
integrate GoFax® into your business application and tools
Register with GoFax®
Sign up and apply GoFax® Send Credits.
Create Token
Create a login token using your master user account.
Start Testing
Test operations of the GoFax® Fax API.
Connect
Launch and enjoy the GoFax® advantage.
Fax API Calls | Description |
---|---|
FAX API – GENERAL |
|
Account_GetDetails |
Get account details |
Account_CreditBalance |
Get Current Send Credit Balance for 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. |
Account_GetDetails |
Get account details |
Account_CreditBalance |
Get Current Send Credit Balance for 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. |
FAX API – 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. |
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 |
CSend 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. |
Fax API – 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 |
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 |
Fax API – System |
|
SystemV_LegalTypes |
Get the list of supported file formats for Fax Send |
SystemV_LegalTypes |
Get the list of supported file formats for Fax Send |
Contact our support team for further details to see
how you can customize your fax sending.
Contact our support team for further details to see how you can customize your fax sending.
Contact our support team for further details to see how you can customize your fax sending.
• reliable
• secure
• no contracts
• outstanding service
• 100% Australian owned & operated
reliable • secure • no contracts • outstanding service • 100% Australian owned & operated