PowerBuilder

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

integer li_rc
integer li_Success
oleobject loo_Rest
integer li_BTls
integer li_Port
integer li_BAutoReconnect
oleobject loo_FileStream
string ls_ResponseStr

li_Success = 0

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

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Use Basic Authentication.
// Use your InterFAX login and password.
li_Success = loo_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.
li_BTls = 1
li_Port = 443
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("rest.interfax.net",li_Port,li_BTls,li_BAutoReconnect)

// Indicate the Content-Type of our upload.  
// We're faxing a PDF, so set the content-type to application/pdf.
li_Success = loo_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)
li_Success = loo_Rest.AddHeader("Expect","100-continue")

loo_FileStream = create oleobject
li_rc = loo_FileStream.ConnectToNewObject("Chilkat.Stream")

// The stream's source will be a file.
loo_FileStream.SourceFile = "qa_data/pdf/fishing.pdf"

// Add query params.
// The fax number format is "+1-212-3456789"
loo_Rest.AddQueryParam("faxNumber","MY-FAX-NUMBER")
loo_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.
ls_ResponseStr = loo_Rest.FullRequestStream("POST","/outbound/faxes",loo_FileStream)
if loo_Rest.LastMethodSuccess <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_FileStream
    return
end if

if loo_Rest.ResponseStatusCode <> 201 then
    // The response was not successful.
    // We can examine the response code, header and status text:
    Write-Debug "Response status code: " + string(loo_Rest.ResponseStatusCode)
    Write-Debug "Response status text: " + loo_Rest.ResponseStatusText
    Write-Debug "Response header: " + loo_Rest.ResponseHeader
    Write-Debug "FAX failed."
else
    Write-Debug "FAX sent."
end if



destroy loo_Rest
destroy loo_FileStream