RingCentral Cloud Fax Integration
Enterprise REST API, Server-to-Server JWT, and automated dual-carrier fax routing
A comprehensive guide to connecting your practice's RingCentral account to Intelligent Office Suite. Configure Server-to-Server JWT credentials, pull carrier DIDs, automate webhook subscriptions, and send/receive clinical faxes with branded practice cover pages.
Overview
RingCentral is a leading global enterprise provider of cloud telecommunications and business communications. By integrating RingCentral with Intelligent Office Suite, practices can use their existing RingCentral telephone lines, DIDs, and enterprise contracts for high-volume digital medical faxing, incoming referral extraction, and clinical records exchange.
Key Integration Capabilities
- Server-to-Server JWT Authentication: Uses RingCentral's modern OAuth 2.0 JWT Bearer flow for headless server-to-server operations without requiring user browser logins or refresh token management.
- Automated Webhook Handshake Validation: Intelligent Office Suite handles RingCentral's
Validation-Tokenchallenge verification automatically during subscription setup, enabling instant push notifications for incoming faxes and outbound transmission statuses. - Live DID Auto-Discovery: Pull active phone numbers with fax capabilities directly from RingCentral with one click inside the Fax Settings console.
- Custom Branded Cover Page Preservation: Intelligent Office Suite automatically attaches your practice's custom-branded PDF cover page (with logo, clinic addresses, and HIPAA confidentiality disclaimers) as page 1, instructing RingCentral (
coverIndex: 0) not to overwrite your layout. - Zero-Friction Fallback: If a location does not have dedicated RingCentral or Sinch lines configured, outbound transmissions seamlessly route through the system-level master line so clinical workflows are never blocked.
Step-by-Step RingCentral Account Configuration
Follow these sequential steps in the RingCentral Developer Console and your Intelligent Office Suite portal:
Create a REST API App in RingCentral
Configure Server-to-Server JWT application
Log into the RingCentral Developer Portal using your RingCentral admin credentials.
- Click Create App > Select REST API App.
- Under Authentication Method, select Server-to-Server JWT (do not select OAuth 2.0 Authorization Code flow, as JWT enables background server-to-server synchronization).
- Give the application a name (e.g.,
Intelligent Office Suite Fax Gateway) and an optional description.
Assign Required Permissions (Scopes)
Grant permissions required for faxing and webhooks
In your App Settings under App Permissions, ensure the following scopes are enabled:
Enables transmitting and downloading digital fax documents.
Allows real-time push webhook notifications for new faxes.
Accesses inbound message details and attachment download links.
Validates extension connection and auto-discovers active fax numbers.
Generate a Server-to-Server JWT Token
Authorize the application for your organization extension
In the app details page, navigate to the Credentials tab:
- Copy the Client ID (App Key).
- Copy the Client Secret (App Secret).
- Under JWT (JSON Web Token), click Create Token. Choose the admin extension representing your clinic office, and copy the generated JWT string.
Connect RingCentral in OfficeSuite
Save encrypted credentials and test live connectivity
In Intelligent Office Suite, navigate to Settings > Integrations:
- Under Communication Integrations, find the RingCentral tile and click Configure RingCentral.
- Enter your Client ID, Client Secret, and JWT Token.
- (Optional) Leave Server URL blank to use the default Production API (
https://platform.ringcentral.com) or enter Sandbox URL if testing. - Click Test Connection. The system will verify your token against RingCentral's extension endpoint.
- Click Save RingCentral Credentials.
Add Fax Number Line & Auto-Bind Webhook
Provision the line for your clinic location and register webhook callbacks
Navigate to Settings > Fax Numbers and click Add Fax Number:
- Set Provider to RingCentral.
- Click Pull from Account: Intelligent Office Suite automatically contacts the RingCentral REST API and loads your active fax phone numbers into the selector.
- Assign the line to a specific clinic location (e.g. Downtown Surgery Clinic) or keep it Office-wide.
- Ensure Send Outbound Referrals and Receive Inbound Referrals are toggled on.
- Click Save Fax Number. Intelligent Office Suite immediately calls the RingCentral Subscription API to register the webhook URL and completes the handshake token validation.
How RingCentral Digital Faxing Operates
Intelligent Office Suite treats RingCentral as a native telecom carrier in the same pipeline as Sinch, providing complete feature parity:
Outbound Fax Pipeline
When a doctor or medical staff member dispatches an outbound referral, order, or record:
- Intelligent Office Suite generates the custom practice-branded PDF cover page.
- Combines cover page and clinical attachments into an encrypted PDF payload.
- Calls RingCentral REST endpoint
POST /restapi/v1.0/account/~/extension/~/faxwithcoverIndex: 0. - Tracks transmission ID, provider status, and records delivery timestamp.
Inbound Webhook & AI Extraction
When an outside clinic or pharmacy faxes your RingCentral line:
- RingCentral posts an event payload to
/api/webhooks/fax/ringcentral. - The webhook handler resolves the destination location and decrypts API tokens.
- Downloads the binary PDF attachment directly from the RingCentral message store.
- Stores the encrypted PDF and triggers automated AI OCR, patient matching, and category assignment.
Troubleshooting & FAQs
Token Expired / Invalid JWT Assertion
Ensure your RingCentral app is set to Server-to-Server JWT and the JWT token was generated for an active admin or service extension. If the token was revoked or regenerated in the RingCentral Developer Console, update the token in Settings > Integrations and click Test Connection.
No Phone Numbers Returned on "Pull from Account"
Verify in your RingCentral Service Portal that the telephone numbers assigned to your company or extension have the Fax feature capability enabled. Voice-only or SMS-only numbers without Fax routing will not be displayed.
Do outbound faxes have two cover pages?
No. Intelligent Office Suite sets coverIndex: 0 (None) when calling the RingCentral Fax API, and directly prepends your clinic's custom-branded PDF cover page as page 1. This ensures full layout control and prevents duplicate cover sheets.