DataFlex

Interfax -- Fax a Single Document

See more REST Examples

Demonstrates how to use the REST API to fax a single document using interfax.net. See Send fax for more information.

This example will send a POST with these potential query params:

POST /outbound/faxes?faxNumber={faxnumber}[&contact={string}&postponeTime={datetime}
&retriesToPerform={number}&csid={string}&pageHeader={string}&reference={string}
&replyAddress={email}&pageSize={a4|letter|legal|b4}&fitToPage={scale|noscale}
&pageOrientation={portrait|landscape}&resolution={fine|standard}&rendering={greyscale|bw}]

The HTTP POST request to be sent will look like this:

POST /outbound/faxes?faxNumber={faxnumber}&... HTTP/1.1
Host: rest.interfax.net
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/msword
 
{binary content goes here}

Note: The Content-Type header field should match type type of document. For example, use "application/pdf" to fax a PDF. To find out what content-type header field values should be used, Google "MIME content type for XYZ" where XYZ describes the type of document. For example, one might Google "MIME content type for Excel xls", and the answer would be "application/vnd.ms-excel". DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoRest
    Boolean iBTls
    Integer iPort
    Boolean iBAutoReconnect
    Variant vFileStream
    Handle hoFileStream
    String sResponseStr
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    Move False To iSuccess

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

    // Use Basic Authentication.
    // Use your InterFAX login and password.
    Get ComSetAuthBasic Of hoRest "INTERFAX_LOGIN" "INTERFAX_PASSWORD" To iSuccess

    // Connect to the Interfax REST server.
    // Make sure TLS is used.  One should NEVER send a username+password using Basic authentication
    // over a non-secure connection.
    Move True To iBTls
    Move 443 To iPort
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "rest.interfax.net" iPort iBTls iBAutoReconnect To iSuccess

    // Indicate the Content-Type of our upload.  
    // We're faxing a PDF, so set the content-type to application/pdf.
    Get ComAddHeader Of hoRest "Content-Type" "application/pdf" To iSuccess

    // We can add an "Expect: 100-continue" header so that if the request is rejected
    // by the server immediately after receiving the request header, it can respond
    // and the client (Chilkat) can avoid sending the file data.
    // (this is optional)
    Get ComAddHeader Of hoRest "Expect" "100-continue" To iSuccess

    Get Create (RefClass(cComChilkatStream)) To hoFileStream
    If (Not(IsComObjectCreated(hoFileStream))) Begin
        Send CreateComObject of hoFileStream
    End

    // The stream's source will be a file.
    Set ComSourceFile Of hoFileStream To "qa_data/pdf/fishing.pdf"

    // Add query params.
    // The fax number format is "+1-212-3456789"
    Get ComAddQueryParam Of hoRest "faxNumber" "MY-FAX-NUMBER" To iSuccess
    Get ComAddQueryParam Of hoRest "pageSize" "letter" To iSuccess
    // Add any other desired query params ...

    // The response is a 0-length "201 Created" response.
    // Therefore the responseStr will be empty.
    Get pvComObject of hoFileStream to vFileStream
    Get ComFullRequestStream Of hoRest "POST" "/outbound/faxes" vFileStream To sResponseStr
    Get ComLastMethodSuccess Of hoRest To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 201) Begin
        // The response was not successful.
        // We can examine the response code, header and status text:
        Get ComResponseStatusCode Of hoRest To iTemp1
        Showln "Response status code: " iTemp1
        Get ComResponseStatusText Of hoRest To sTemp1
        Showln "Response status text: " sTemp1
        Get ComResponseHeader Of hoRest To sTemp1
        Showln "Response header: " sTemp1
        Showln "FAX failed."
    End
    Else Begin
        Showln "FAX sent."
    End



End_Procedure