SQL Server

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

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

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

    DECLARE @rest int
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Use Basic Authentication.
    -- Use your InterFAX login and password.
    EXEC sp_OAMethod @rest, 'SetAuthBasic', @success OUT, '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.
    DECLARE @bTls int
    SELECT @bTls = 1
    DECLARE @port int
    SELECT @port = 443
    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, '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.
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, '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)
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Expect', '100-continue'

    DECLARE @fileStream int
    EXEC @hr = sp_OACreate 'Chilkat.Stream', @fileStream OUT

    -- The stream's source will be a file.
    EXEC sp_OASetProperty @fileStream, 'SourceFile', 'qa_data/pdf/fishing.pdf'

    -- Add query params.
    -- The fax number format is "+1-212-3456789"
    EXEC sp_OAMethod @rest, 'AddQueryParam', @success OUT, 'faxNumber', 'MY-FAX-NUMBER'
    EXEC sp_OAMethod @rest, 'AddQueryParam', @success OUT, 'pageSize', 'letter'
    -- Add any other desired query params ...

    -- The response is a 0-length "201 Created" response.
    -- Therefore the responseStr will be empty.
    DECLARE @responseStr nvarchar(4000)
    EXEC sp_OAMethod @rest, 'FullRequestStream', @responseStr OUT, 'POST', '/outbound/faxes', @fileStream
    EXEC sp_OAGetProperty @rest, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @fileStream
        RETURN
      END

    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    IF @iTmp0 <> 201
      BEGIN
        -- The response was not successful.
        -- We can examine the response code, header and status text:

        EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
        PRINT 'Response status code: ' + @iTmp0

        EXEC sp_OAGetProperty @rest, 'ResponseStatusText', @sTmp0 OUT
        PRINT 'Response status text: ' + @sTmp0

        EXEC sp_OAGetProperty @rest, 'ResponseHeader', @sTmp0 OUT
        PRINT 'Response header: ' + @sTmp0

        PRINT 'FAX failed.'
      END
    ELSE
      BEGIN

        PRINT 'FAX sent.'
      END

    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @fileStream


END
GO