Fax API Calls

CreateLoginToken

This call is used to create a login token. Login tokens can only be created by the master user account for the client.

CheckHaveAccess

This call is used to check GoFax system accessibility using your token. Returns ‘true‘, if access is permitted; returns ‘false’ otherwise.

GetQueueStatus

This call returns the status of the fax queue.

LegalTypes

This call returns the list of the file types accepted for sending faxes via the GoFax Send service.

GetFaxDocument

This call returns detailed information about the specific fax transaction attempted.

ResendFax

This call is used to re-send the fax that was previously attempted.

SendFax

This call is used to send one or more attached files as a fax.

SendFaxData

This call returns the specific fax document sent.

SendFaxDocument

This call is used to send one attached file as a fax.

SendFaxDocument_GetID

This call is used to send one attached file as a fax. As a result the fax transmission will be attempted and the fax ID will be returned.

SendFaxDocument_V2

This call, in addition to sending an attached file as a fax, allows a sender to specify the number of retries. As a result the fax transmission will be attempted and the fax ID will be returned.

SendFaxDocument_V3

This call allows a sender to specify the number of retries and schedule faxes sent from email for a time in advance. As a result the fax ID will be returned and the fax transmission will be attempted as scheduled.

SendFaxDocument_V4

In addition to SendFaxDocument_V3 this call allows the sender to add a CallbackURL which a GET request will be made to after the fax has been sent.

SendFaxDocument_V5

In addition to SendFaxDocument_V4 this call allows the sender to add a ClientReference which stores the supplied value against the fax metadata. This is great for users wanting to run reports but using their own fax identifier.

SendFaxTransmission_GetStatus

This call is used to get the status of the fax submitted.

SendFaxTransmission_IDsForDate

This call is used to get the ID’s of the faxes sent on a specific day.

SentFax_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. Conversion in Progress.

SentFaxes

This call is used to get the detailed information about the last 50 faxes submitted.

SentFaxesOutbox

This call is used to get the detailed information about the last 50 faxes submitted.