PureBasic

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". PureBasic

IncludeFile "CkRest.pb"
IncludeFile "CkStream.pb"

Procedure ChilkatExample()

    success.i = 0

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Use Basic Authentication.
    ; Use your InterFAX login and password.
    success = CkRest::ckSetAuthBasic(rest,"INTERFAX_LOGIN","INTERFAX_PASSWORD")

    ; 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.
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"rest.interfax.net",port,bTls,bAutoReconnect)

    ; Indicate the Content-Type of our upload.  
    ; We're faxing a PDF, so set the content-type to application/pdf.
    success = CkRest::ckAddHeader(rest,"Content-Type","application/pdf")

    ; 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)
    success = CkRest::ckAddHeader(rest,"Expect","100-continue")

    fileStream.i = CkStream::ckCreate()
    If fileStream.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; The stream's source will be a file.
    CkStream::setCkSourceFile(fileStream, "qa_data/pdf/fishing.pdf")

    ; Add query params.
    ; The fax number format is "+1-212-3456789"
    CkRest::ckAddQueryParam(rest,"faxNumber","MY-FAX-NUMBER")
    CkRest::ckAddQueryParam(rest,"pageSize","letter")
    ; Add any other desired query params ...

    ; The response is a 0-length "201 Created" response.
    ; Therefore the responseStr will be empty.
    responseStr.s = CkRest::ckFullRequestStream(rest,"POST","/outbound/faxes",fileStream)
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkStream::ckDispose(fileStream)
        ProcedureReturn
    EndIf

    If CkRest::ckResponseStatusCode(rest) <> 201
        ; The response was not successful.
        ; We can examine the response code, header and status text:
        Debug "Response status code: " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "Response status text: " + CkRest::ckResponseStatusText(rest)
        Debug "Response header: " + CkRest::ckResponseHeader(rest)
        Debug "FAX failed."
    Else
        Debug "FAX sent."
    EndIf



    CkRest::ckDispose(rest)
    CkStream::ckDispose(fileStream)


    ProcedureReturn
EndProcedure