Http Post - FaxReceiveNotify

This SOAP service is defined / supported in order for the customer to implement their own web service for processing received faxes. The Concord Fax Network will notify the customer by making a web service call to the customer's end point.

HttpContentType setting

text/xml

Http Header Template setting

The Http Header Template setting provides the URL that notifications should be posted to. The template should be provided to Concord Customer Service before this method can be used.

Examples URL's:

  • Format: {protocol}://{server}/{page}

    Header Format: HTTP_{header} = "{headervalue}"

    Note

    • {protocol} : http or https

    • {server} : server address to post notification to

    • {page} : page to post form data to. Can be ommitted if url does not have a page name

    • {header} : header to add to post. Example HTTP_SOAPAction or HTTP_CustomHeader

    • {headervalue} : value to assign to {header}.

  • https://yourserver.com/faxnotify.aspx

    HTTP_SoapAction = "https://yourserver.com/FaxNotify"

  • https://yourserver.com/faxnotify.htm

    HTTP_SoapAction = "https://yourserver.com/FaxNotify"

  • https://yourserver.com/faxnotify/

    HTTP_SoapAction = "https://yourserver.com/FaxNotify"

  • https://yourserver.com/faxnotify

    HTTP_SoapAction = "https://yourserver.com/FaxNotify"

Security Note

For security reasons we strongly recommend to use the Https protocol.

Http Body Template setting

Xml Copy imageCopy
POST / ConcordFaxReceiveNotifyWS/Service.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "CFRNNS/FaxReceiveNotify"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <FaxReceiveNotify xmlns="CFRNNS">
            <faxDetails>
                <AuthUser>string</AuthUser>
                <AuthPassword>string</AuthPassword>
                <Account>string</Account>
                <CalledNumber>string</CalledNumber>
                <CallerNumber>string</CallerNumber>
                <FaxReceiveDateTime>string</FaxReceiveDateTime>
                <FaxDuration>int</FaxDuration>
                <FaxPartialFlag>int</FaxPartialFlag>
                <FaxPages>int</FaxPages>
                <FaxSpeed>int</FaxSpeed>
                <FaxFormat>string</FaxFormat>
                <FaxMessageId>string</FaxMessageId>
                <FaxResolution>string</FaxResolution>
                <FaxSenderCSID>string</FaxSenderCSID>
                <FaxRecipientTimeZone>string</FaxRecipientTimeZone>
                <FaxFiles>
                    <FaxFile>
                        <FileName>string</FileName>
                        <FileData>base64Binary</FileData>
                    </FaxFile>
                    <FaxFile>
                        <FileName>string</FileName>
                        <FileData>base64Binary</FileData>
                    </FaxFile>
                </FaxFiles>
            </faxDetails>
        </FaxReceiveNotify>
    </soap:Body>
</soap:Envelope>

In response to the WS call, the client side WS will need to respond with the following response:

Xml Copy imageCopy
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <FaxReceiveNotifyResponse xmlns="CFRNNS">
            <FaxReceiveNotifyResult>
                <Status>int</Status>
                <ErrorCode>int</ErrorCode>
                <ErrorDescription>string</ErrorDescription>
            </FaxReceiveNotifyResult>
        </FaxReceiveNotifyResponse>
    </soap:Body>
</soap:Envelope>

Guidelines for implementing the web service

A status value of '0' indicates that the request was processed successfully. Any value other than 0 indicates an error and ErrorCode and ErrorString should be set to indicate the details on the error.

  • Use the WSDL file for creating the web service (In a .NET environment, you should be able to generate the source files from wsdl using the WSDL tool).

  • The implementation should return FaxReceiveNotifyResponse object with the appropriate results. If the web service was able to process the Fax Message successfully, the 'Status' value should be set to '0' to indicate a success. Any value other than '0' will indicate a failure and Fax server will retry the operation a number of times at periodic intervals.

  • Minimize the processing time on each request. Otherwise the WS call may timeout and the Fax server iwll retry the operation.

Concord provides a working sample .net web service which is availalbe to customers for reference. This sample Web service perofrms the following functions:

  • Logs the details of the received fax to a log file (Log4net)

  • Saves the received fax to a directory.

See Also