Cloud Fax API use case by example

We’ve seen every use-case one could imagine. With each new customer we learn new ways to use the API. Below are several of the very common use-cases we see all the time and the API calls involved with each. We’ll use pseudo-code in our examples to describe workflow.


Outbound heavy

In this use-case the user sends large numbers of outbound faxes with no need for inbound. For each fax they need to reconcile delivery. If something fails they need to determine the reason why and act accordingly. (Number of API Calls: 2)

  1. Get faxes ready for send:
    -Generate Content to be faxed (PDF,DOC, HTML, etc…)
    -Generate the API Requests with the Outbound CallbackUrl set (learn more)
  2. Fax send loop:
    -Send requests in a Loop (API Call: Fax_SendFax)
  3. Wait for Callback:
    -Callback fires and we read the fax identifier from the callback request.
    -Get status using: (API Call: Fax_GetFaxDescriptionsUsingIds) using the fax identifier
    –[Ok] -> Write to database and mark as complete.
    –[Failed] -> Write to database for later review or retry.

Inbound heavy

In this use-case the user receives large numbers of inbound faxes with no need for outbound. They use the inbound webhook to receive notification of new inbound fax. For each fax they receive they will save the fax to a network drive and send an internal email to their users. (Number of API calls: 2)

  1. Webhook call received with fax identifier.
  2. Get inbound fax information and file.
    -Get information about the fax: (API Call: Fax_GetFaxDocuments) using fax identifier.
  3. Save fax file
    -Decode file using any BASE64 Decode function and save as the selected filetype.
    -Save file to network location
    -Mark fax as “retrieved”: (API Call: Fax_ChangeFaxFilterValue)
  4. Notify users of new fax arriving using internal email