Skip to content

Send a status push message to the URL of your choice

Request

Notification via HTTP implies the customer is operating an HTTP server that accepts the specified URL HTTP POST requests from Retarus' infrastructure. The customer should provide and configure:

  • A target web service accepting HTTP POST requests
  • An authentication method. The following are supported at the moment:
    • HTTP_BASIC
    • HTTP_DIGEST
    • OAUTH2
    • NONE

The parameters should be provided in each HTTP request made in Faxolution for Applications. By default, the format of the status push is the same as the response to a getFaxReports in the Faxolution for Applications SOAP API. If you prefer to use a custom format, please contact Retarus.

In the corresponding HTTP response from the customer’s server, a status code in the 200-299 range is expected if the HTTP request was successfully received. If there are errors, a status code in the 400-499 range (in cases of erroneous requests) or the 500-599 range (in cases of HTTP server errors) should be provided.

Body
required

Fax status push message as a ReportResponse object

jobIdstring

The Job ID. Summarizes all faxes of a send request, if there is more than one.

reportMailobject(reportMail)
httpStatusPushobject(httpStatusPush)
faxRecipientsArray of objects(faxRecipients)
documentsArray of objects(documents)
optionsobject(options)
pagesinteger(pages)

Number of pages in the fax document, as long as it was successfully delivered.

POST
/your/desired/path
curl -i -X POST \
  https://developers.retarus.com/_mock/fax/status-push-api/your/desired/path \
  -H 'Content-Type: text/xml' \
  -d '<root>
    <jobId>FJIJPNJYN906EDIJNFGI5S</jobId>
    <faxRecipients>
      <number>+4989123456789</number>
      <status>OK</status>
      <sentTs>2023-01-03T15:38:08Z</sentTs>
      <sentToNumber>004989123456789</sentToNumber>
      <remoteCsid>+49/89/1234567-89</remoteCsid>
    </faxRecipients>
    <documents>
      <name>document.pdf</name>
    </documents>
    <options>
      <billingCode>My BC 123</billingCode>
      <billingInfo>Default billing code</billingInfo>
      <jobReference>My Reference ID</jobReference>
    </options>
    <pages>2</pages>
  </root>'

Responses

OK: The job was processed properly on your side (example)