The Fax Guys

Your RightFax Support Experts

  • (952) 224-3340
  • Home
  • Request a Quote
  • Help Desk Login
  • About Us
    • Who We Are
    • Why Fax Automation?
    • Is RightFax the Correct Fax Server Software for Me?
    • Industry Solutions
      • Healthcare
      • Financial Services
      • Government, Schools and Public Organizations
      • Manufacturing and Supply Chain
      • Legal and Professional Services
    • Jobs – Are The Fax Guys Hiring?
  • Our Solutions
    • OpenText RightFax
      • OpenText RightFax 16.6
      • RightFax Express
    • Cloud Faxing
      • RightFax Connect
      • OpenText Cloud Faxing
    • RightFax Modules
      • Diem Mail to Fax
      • RightFax Management Pack for SCOM
      • Universal RightFax MFP Connector Module
    • Dashboards & BI
      • Intuitive Dashboards for RightFax
      • FaxPulse BI – RightFax Dashboards
    • Fax System Monitoring
      • FaxPing
      • Request a Free RightFax Health Check
    • SIP Trunking
      • SIP Trunking
      • Types of Telco Connections: SIP Trunks for RightFax
      • Dialogic® Brooktrout® Tested FoIP Interoperability
  • Resources & Support
    • Open a Helpdesk Ticket
    • RightFax Support
    • Redundancy & Disaster Recovery
    • RightFax Supported Versions
    • Integrations
      • RightFax and Epic
      • RightFax and Meditech
    • Downloads
      • RightFax User Guides
      • OpenText RightFax Software Maintenance Program Handbook
    • OpenText Knowledge Center
    • Dialogic Brooktrout Board Advanced Replacement Plans
  • RightFax University
    • About RFU
  • Blog
  • Contact Us

RightFax API Documentation including XML / Web Services and COM API

RightFax10_Integrations-Feb-17-2012RightFax has a variety of APIs available for integration.  If you have an application that you would like to integrate with RightFax, please contact us and we’ll do our absolute best to direct you to the correct method.

Embedded Codes

Embedded codes are special faxing instructions that you insert directly into fax-bound documents. You can use embedded codes to address faxes, include fax cover sheet information, attach library documents, add billing information, insert your signature, and more.

To add an embedded code to a document, type the code you want, along with any required parameters, between angle brackets. For example, an embedded code that tells RightFax the destination fax number and recipient is written as:

<TOFAXNUM:952-224-3343>
<TONAME:Customer ABC>

The fax server removes all embedded codes from a document when it converts the document to fax form, so they don’t appear in your final fax. Embedded codes can be written in either upper or lower case. If you type an embedded code incorrectly, it will not behave as expected and the embedded code text itself will appear in your fax.

Embedded codes can be placed anywhere in the document that you will be faxing, and can be used in any document that accepts text characters. Embedded codes cannot line wrap and any embedded code statement that is so long that it wraps to a second line will be ignored.

Integration Module / Facsimile Command Language (FCL)

The RightFax Integration Module enables applications for information exchange by integrating with applications on mainframe, mid-range, and local area network host systems. Together, the RightFax server and the Integration Module will send any document created by these applications via fax, e-mail, or over the Internet.

The RightFax Integration Module automates batch-oriented, repetitive processes. It is designed to support applications that produce output that traditionally is sent to a printer, printed on pre-printed forms, folded, stuffed in envelopes, and then mailed or manually faxed. These documents can include invoices, itineraries, purchase orders, statements, order confirmations, loan applications, bills of lading, change orders, financial reports, and material safety data sheets.

FCLSample

COMAPI

The RightFax COMAPI was introduced in RightFax 7.x and enables easy integration using the RFCOMAPI.DLL.  The RightFax COM API is a library of objects, properties, and methods designed for use in developing custom applications for the RightFax server. The RightFax COM API library is compatible with any programming language that supports binary standards including C, C++, Java, JScript, Visual Basic, VBScript, Delphi, and PowerBuilder.

WebServices

RightFax Basic Web Services adds robust, advanced integration capability geared for custom web applications and enterprise application integrations. The interface accepts and executes web services requests for basic sending, receiving, and providing status for fax documents.  For more information on Web Services API

Advanced Web Services (AWS)

Advanced Web Services is similar to Basic Web Services, yet requires a separate license. Advantages to using Advanced Web Services include: 

  • It is a Windows Communication Foundation service, which allows you to provide more granular security options for communicating with the service
  • Does not require Internet Information Server to be installed. It is a standalone Windows Service
  • More robust documentation and sample code
  • Allows an application to quickly check the status of one or more faxes without the overhead of retrieving all information about the fax. This requires far less bandwidth.
  • A single instance of the web service allows access to multiple RightFax servers. It does not need to be installed on each RightFax server. In fact, it does not need to be installed on a RightFax server at all but can be installed on a completely separate computer. The only requirements are that this separate computer needs to have the RightFax FaxUtil client installed and network access to the computer(s) hosting the RightFax Server.
  • Customization and feature enhancements are available. Contact OpenText Professional Services for more information.

Java/XML

The RightFax XML Interface converts XML to FCL. For host applications that produce XML and can’t be modified to produce FCL, the RightFax XML Interface provides a beneficial option.  When the Integration Module receives an XML-based document, the RightFax XML Interface converts it to an FCL-encoded document.  The XML Interface software performs four functions (submit, query, action, and notification) via three methods of transport (HTTP or HTTPS, FTP, and IBM WebSphere MQ). XML Interface functionality is achieved by creating XML documents that adhere to RightFax schemas.

The RightFax API for Java is for Java programmers. It provides an alternate method of creating and sending XML to the RightFax server. The API for Java allows access to XML Interface functionality without requiring that a customer know XML or the RightFax XML Interface schemas.

Other Integrations

We have other integrations using SAP, Oracle, SMTP, PDF files, and PCL files.  Let us know if you need those options too!  For more information on these APIs, please contact us at 952-224-3340 Option 1 or sales@thefaxguysot.wpengine.com



How Can We Help?
Call Us
Want to chat with our team?
We’re here to help.
Give us a call!

952-224-3340
Request A Quote
We’ll custom-tailor a solution to your exact needs with a rapid turnaround!
Free Online Learning
RightFax University is our FREE Online Learning Classroom.

300+ Videos | Webinars & Product Guides | Always 100% Free
Key Resources
Integrating RightFax With MS Office 365
How To Send A Fax From Outlook
Creating A RightFax Coversheet
RightFax Fax Over IP & SIP Trunking
RightFax API Documentation
RightFax Support
Stay Up To Date
Sign up to receive product updates and the latest RightFax news & notes.

Download Your FREE RightFax Starter Guide Today

If you’re considering RightFax for your organization or looking for a new support partner, this informative
FREE guide will give you insight you need to evaluate and select the right RightFax reseller for your business.

Download your FREE guide today to learn the 8 Questions That Will Make Finding Your Next RightFax Reseller…A Breeze.

GET YOUR FREE DOWNLOAD

© 2023 · The Fax Guys, a division of Dynamic Solutions Group · All rights reserved

Privacy Policy · Cookie Policy · Site Map

This website uses cookies to improve your experience. We'll assume you're ok with this, but you can opt-out if you wish.Accept Read More
Privacy & Cookies Policy
Necessary Always Enabled