(Ruby) Interfax -- Fax a Single Document

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

Chilkat Ruby Downloads

install from rubygems.org
gem install chilkat
or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

rest = Chilkat::CkRest.new()

# Use Basic Authentication.
# Use your InterFAX login and password.
success = rest.SetAuthBasic("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 = true
port = 443
bAutoReconnect = true
success = rest.Connect("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 = rest.AddHeader("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 = rest.AddHeader("Expect","100-continue")

fileStream = Chilkat::CkStream.new()

# The stream's source will be a file.
fileStream.put_SourceFile("qa_data/pdf/fishing.pdf")

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

# The response is a 0-length "201 Created" response.
# Therefore the responseStr will be empty.
responseStr = rest.fullRequestStream("POST","/outbound/faxes",fileStream)
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

if (rest.get_ResponseStatusCode() != 201)
    # The response was not successful.
    # We can examine the response code, header and status text:
    print "Response status code: " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response status text: " + rest.responseStatusText() + "\n";
    print "Response header: " + rest.responseHeader() + "\n";
    print "FAX failed." + "\n";
else
    print "FAX sent." + "\n";
end