HTTP status push

It is recommended to configure Retarus Fax-for-Applications to push the status reports to a customer’s web service, so that the sending application can be proactively notified of the transmission outcome.

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 the following:

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.

By default, the format of the status push is the same as the response to a getFaxReports in the Fax-for-Applications SOAP API, see the example below. If you prefer to use a custom format, contact Retarus.

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

HTTP status push example

XML

<faxJobReport xmlns="http://retarus.com/fax4ba/faxws/3/0">
	<jobId>FJIJPNJYN906EDIJNFGI5S</jobId>
	<reportMail>
		<successAddress></successAddress>
		<failureAddress></failureAddress>
		<attachedFaxImageMode>NEVER</attachedFaxImageMode>
		<attachedFaxImageFormat>TIFF</attachedFaxImageFormat>
	</reportMail>
	<httpStatusPush>
		<url>https://statuslistener.example.com:9564/Faxolution-v3.0</url>
		<authMethod>HTTP_BASIC</authMethod>
	</httpStatusPush>
	<faxRecipient>
		<number>+498912504001710</number>
		<numId>FNIJPNJYNA06EDIJNFUO1Q</numId>
		<status>OK</status>
		<reason>OK</reason>
		<sentTS>2018-11-08T15:38:08Z</sentTS>
		<durationInSecs>26</durationInSecs>
		<sentToNumber>00498912504001710</sentToNumber>
		<remoteCsid>+49/89/1250400-1710</remoteCsid>
	</faxRecipient>
	<document>
		<name>document.pdf</name>
		<isText>false</isText>
	</document>
	<options>
		<resolution>HIGH</resolution>
		<csid>Example Inc.</csid>
		<header>Fax from %C to %#%r%Y-%m-%d</header>
		<isBlacklistEnabled>false</isBlacklistEnabled>
		<isExpress>true</isExpress>
		<overlay>
			<name></name>
			<mode>ALL_PAGES</mode>
		</overlay>
		<coverpageTemplateName></coverpageTemplateName>
		<jobExpiryMinutes>50</jobExpiryMinutes>
		<billingCode>My BC</billingCode>
		<billingInfo></billingInfo>
		<jobReference>My Reference ID</jobReference>
	</options>
	<pages>2</pages>
</faxJobReport>