Fax-to-Webservice: Push API

Retarus Fax-to-Webservice allows fax documents to be received via the Retarus system and delivered to business applications or web applications via HTTPS. Inbound faxes are transmitted in PDF or TIFF format via WebService POST (SOAP_POST, JSON_POST, PLAIN-POST or BASE64_POST).

Output is delivered typically in SOAP/XML or REST/JSON format. This output contains the job data and documents in base64 encoded format.

Besides the received fax document additional documents may be included in the out, depending on whether additional inbound services like OCR and/or barcode recognition are conifigured.

Output file creation

The application uses a template engine to generate the output content. This output contains the job data and documents in base64 format.

Output examples

Below, you will find two examples of the output formats:

JSON output
SOAP output

JSON output

JSON

{"Fax":{
  "Authentication":{
    "AuthenticationMethod": "UserPassword",
    "Username": "User",
    "Password": "xxxx"
  },
  "FaxDetails": {
    "JobID" : "K34A3QX3@J78AO6W.glaqsmucre101.QA1",
    "DateReceived": "2019-11-18T11:21:04+0100",
    "CalledNumber": "+498926208yyyy",
    "RemoteCSID": "Retarus Testfax",
    "CSID" : "Retarus Intern",
    "BillingCode": "",
    "FileType": "tiff",
    "Resolution" : "HIGH",
    "TotalDuration": "21",
    "BaudRate": "33600",
    "PageCount": "1",
    "Status": "OK",
    "CallingNumber" : "0049892444xxxx",
    "ArchivingStatus" : "not configured",
    "ArchivedUntil": null,
    "Service": "Fax2WS"
  },
  "FaxFile":[
         
        {"FileType": "tiff",
        "FileName": "K34A3QX3@J78AO6W.glaqsmucre101.QA1.tiff",
        "FileContent" : "TU0AKgAAAAgAEAEAAAQAAAABAAAGwAEBAAQAAAABAAAJEAECAAMAAAABAAEAAAEDAAMAAAAB...cut...LobYoqN00Scu4hMXPeIRF3ERjzgxxDZ94hPHxEUXcREXcfHEF3ERF/HpYot4nIiLMXERF/GJzxbx6WJMfLroYkwXCFIABEA="}
  ]
}}

SOAP output

XML

<?xml version="1.0" encoding="UTF-8"?>
<Fax>
    <Authentication>
        <AuthenticationMethod>UserPassword</AuthenticationMethod>
        <Username>User</Username>
        <Password>xxxxx</Password>
    </Authentication>
    <FaxDetails>
        <JobID>KNFUI0UY@5VYN7BX.glagmucre114.MUCRE1</JobID>
        <DateReceived>2021-04-13T11:51:37+0200</DateReceived> <!-- Date/Time of the fax transmission -->
        <CalledNumber>+49891250410yyyy</CalledNumber>
        <SenderFaxId>+49 89 1250400-xxxx</SenderFaxId>
        <FaxName>FAX ID TEST</FaxName>
        <AccountID></AccountID>
        <FileType>tiff</FileType>
        <Resolution>HIGH</Resolution>
        <TotalDuration>15</TotalDuration>
        <BaudRate>33600</BaudRate>
        <PageCount>1</PageCount>
        <Status>OK</Status>
        <CSID>FAX ID TEST</CSID>
        <CallingNumber>0049891250400xxxx</CallingNumber>
        <Service>Fax2WS</Service>
    </FaxDetails>
    <FaxFile>
        <FileType>tiff</FileType>
        <FileName>KNFUI0UY@5VYN7BX.glagmucre114.MUCRE1.tiff</FileName>
        <FileContent>SUkqAGAHAACzMh+zxszMCnMwB/NMhJnNGso2MZiDaUowG7PGHEy5+ZgBZWBmZ....cut....AAABAAAAxAAAAAEAAABSZXRhcnVzIE1pbmlHbGFkaWF0b3IA</FileContent>
    </FaxFile>
    <FaxFile>
        <FileType>txt</FileType>
        <FileName>KNFUI0UY@5VYN7BX.glagmucre114.MUCRE1_ocr.txt</FileName>
        <FileContent>77u/MTMuMDQuMjAyMSAxMTo1MTozOAorNDkgODkgMTI1MDQwMC14eHh4CnJldGFydXMgR21iSCAxLzEKSGVsbG8sIHRoaXMgaXMgYSB0ZXN0IGZheCBkb2N1bWVudCBib2R5Lg==</FileContent>
    </FaxFile>
</Fax>