Difference between revisions of "Faxing"
(Created page with "== Description == Typical workflow for interacting with the Faxing capabilities of UpdoxAPI. == How does a practice get a fax number? == Once a practice has been [API_Method_...") |
|||
| Line 3: | Line 3: | ||
== How does a practice get a fax number? == | == How does a practice get a fax number? == | ||
| − | Once a practice has been [API_Method_PracticeCreate|created], a list of numbers available for provision to the created practice can be obtained by calling [[API_Method_AvailableFaxNumbersList|/availableFaxNumbersList]]. | + | Once a practice has been [[API_Method_PracticeCreate|created]], a list of numbers available for provision to the created practice can be obtained by calling [[API_Method_AvailableFaxNumbersList|/availableFaxNumbersList]]. Provisioning the desired fax number is done with a call to [[API_Method_FaxNumberProvision|/faxNumberProvision]]. |
| − | + | ||
| − | + | ||
== How does the practice send a fax? == | == How does the practice send a fax? == | ||
| − | Once the practice is provisioned with a fax number, send the fax | + | Once the practice is provisioned with a fax number, calling [[API_Method_FaxOemSend|/faxOemSend]] with the base64-encoded .pdf file data will send a fax to the provided phone number. To obtain a final disposition of the fax, subsequent polling of [[API_Method_FaxStatusGet|/faxStatusGet]] can be performed until a success or failure response is obtained. |
| − | + | ||
== How does someone send a fax to the practice? == | == How does someone send a fax to the practice? == | ||
| − | Someone wishing to send a fax to a configured practice will simply send their fax to the number provisioned for the practice. They need not do anything different nor even know that the receive side of the fax will be digital and that no actual fax machine is listening | + | Someone wishing to send a fax to a configured practice will simply send their fax to the number provisioned for the practice. They need not do anything different nor even know that the receive side of the fax will be digital and that no actual fax machine is listening at the practice. |
== How does the practice know that they've received a fax and retrieve it? == | == How does the practice know that they've received a fax and retrieve it? == | ||
| − | + | Periodic polling of [[API_Method_FaxOemPop|/faxOemPop]] will return information about fax items on the practice's queue. Calling [[API_Method_FaxOemPop|/faxOemPop]] without providing the <code>lastRetrievedFaxId</code> will return the first fax ever sent to the practice, with the fax's <code>messageId</code>. A subsequent call to [[API_Method_FaxOemPop|/faxOemPop]] that provides the just-received <code>messageId</code> will return the next fax (if present). Repeated iterations of this process will iterate the practice's fax queue. | |
Revision as of 08:09, 24 July 2014
Contents |
Description
Typical workflow for interacting with the Faxing capabilities of UpdoxAPI.
How does a practice get a fax number?
Once a practice has been created, a list of numbers available for provision to the created practice can be obtained by calling /availableFaxNumbersList. Provisioning the desired fax number is done with a call to /faxNumberProvision.
How does the practice send a fax?
Once the practice is provisioned with a fax number, calling /faxOemSend with the base64-encoded .pdf file data will send a fax to the provided phone number. To obtain a final disposition of the fax, subsequent polling of /faxStatusGet can be performed until a success or failure response is obtained.
How does someone send a fax to the practice?
Someone wishing to send a fax to a configured practice will simply send their fax to the number provisioned for the practice. They need not do anything different nor even know that the receive side of the fax will be digital and that no actual fax machine is listening at the practice.
How does the practice know that they've received a fax and retrieve it?
Periodic polling of /faxOemPop will return information about fax items on the practice's queue. Calling /faxOemPop without providing the lastRetrievedFaxId will return the first fax ever sent to the practice, with the fax's messageId. A subsequent call to /faxOemPop that provides the just-received messageId will return the next fax (if present). Repeated iterations of this process will iterate the practice's fax queue.
