Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

Created: 2026-01-28
Status: ✅ Analysis Complete
Owner: CE (Community Engagement)
Related Specs: CE-03, CE-03-E1, CE-08

​
Executive Summary

Current Status: CE-03 (Call Management), CE-03-E1 (Click-to-Call & Screen Pop), and CE-08 (SMS Messaging) are 100% complete and provide a solid foundation for RingCentral integration. Key Finding: The current implementation uses RingOut API (rings user’s phone first) rather than RingCentral Embeddable (in-browser WebRTC calling). This is appropriate for organizations using desk phones or the RingCentral mobile app. Primary Recommendations:
  1. Continue with current RingOut approach - Production-ready and works well with existing infrastructure
  2. Add call controls (transfer/hold) - If users need transfer capabilities (CE-03-E2)
  3. Add voicemail access - If users want voicemail in-app (CE-03-E3)
  4. Consider Embeddable (CE-14) - Only if organization moves away from desk phones

​
Analysis Objective

Purpose: Evaluate current RingCentral integration implementation against RingCentral Embeddable capabilities to identify gaps and recommend the best path forward for call logging, calling, and SMS features. Scope:
  • In Scope: CE-03, CE-03-E1, CE-08 implementation status; RingCentral Embeddable capabilities; gap identification; recommendations
  • Out of Scope: Implementation of new features (this is analysis only)
Methodology:
  • Code review of existing implementation
  • Research of RingCentral Embeddable documentation
  • Comparison of current features vs. available capabilities
  • Analysis of rc-unified-crm-extension (Chrome extension framework)

​
Current State Analysis

​
✅ What We Have

CE-03: Call Management & RingCentral Integration
  • Status: ✅ Complete (100%)
  • Location: specs/ce/specs/CE-03-call-management-ringcentral.md
  • Capabilities:
    • Webhook-based automatic call logging
    • Call recording playback via proxy
    • Call disposition workflow
    • Phone-to-contact/partner matching
    • Extension-to-user mapping
    • Manual call logging
    • Platform Telephony Integration Layer
  • Limitations:
    • No in-browser call controls (transfer, hold, mute)
    • No voicemail access
CE-03-E1: Click-to-Call & Screen Pop
  • Status: ✅ Complete (100%)
  • Location: specs/ce/specs/CE-03-E1-click-to-call-screen-pop.md
  • Capabilities:
    • RingOut API integration (rings user’s phone first)
    • Click-to-call button component
    • Screen pop notifications via Supabase Realtime
    • Contact/partner context in screen pop
    • Rate limiting (20 calls/user/hour)
  • Limitations:
    • Uses RingOut (requires phone hardware/app)
    • No in-browser WebRTC calling
CE-08: SMS Messaging
  • Status: ✅ Complete (100%)
  • Location: specs/ce/specs/CE-08-sms-messaging-integration.md
  • Capabilities:
    • Two-way SMS via RingCentral/Twilio
    • TCPA compliance with opt-out handling
    • PHI detection with configurable modes
    • SMS conversation UI with real-time updates
    • Template system with merge fields
    • Consent management
  • Limitations:
    • None identified (superior to Embeddable SMS)

​
❌ What We’re Missing

Call Controls (Hold, Transfer, Mute)
  • Impact: Receptionists cannot transfer calls; users cannot hold/mute during calls
  • Priority: High (if transfer needed)
  • Estimated Effort: 3-5 days
  • Dependencies: RingCentral Call Control API, active call tracking
Voicemail Access
  • Impact: Users must use RingCentral app for voicemail
  • Priority: Medium (convenience feature)
  • Estimated Effort: 2-3 days
  • Dependencies: RingCentral Message Store API
In-Browser WebRTC Calling
  • Impact: Users must answer phone (desk phone or mobile app)
  • Priority: Low (current RingOut approach works well)
  • Estimated Effort: 2-3 weeks
  • Dependencies: RingCentral Embeddable integration
Presence/Status
  • Impact: Cannot see user availability
  • Priority: Low
  • Estimated Effort: Low (requires Presence API)
  • Dependencies: RingCentral Presence API

​
Gap Analysis: Current vs. RingCentral Embeddable

#StatusCapabilityCurrent StateRingCentral EmbeddableGap
1✅Click-to-CallRingOut API (rings phone first)In-browser WebRTCDifferent approach
2✅Screen PopSupabase Realtime + ToastBuilt-in eventsDifferent approach
3✅Call LoggingCustom call log UIBuilt-in historyNone (we have better)
4✅SMSCustom SMS UI (CE-08)Built-in SMS widgetNone (we have better)
5❌Call ControlsNoneHold, transfer, muteMajor
6❌VoicemailNoneAccess and playbackMajor
7✅Recording PlaybackCustom playerBuilt-inNone
8❌Call TransferNoneTransfer APIMajor
9❌In-Browser CallingRingOut onlyWebRTC softphoneMajor (if needed)
10❌PresenceNoneUser availability statusMinor

​
Detailed Findings

​
Finding 1: RingOut vs. Embeddable - Different Approaches

Description: Current implementation uses RingOut API which rings the user’s phone first, then connects to the target. RingCentral Embeddable provides in-browser WebRTC calling. Evidence:
  • CE-03-E1 implements RingOut via ringcentral-ringout edge function
  • RingOut works with existing desk phones and RingCentral mobile app
  • Embeddable requires WebRTC (browser permissions, microphone/camera)
Impact:
  • RingOut Pros: Works with existing infrastructure, better audio quality, no browser dependencies, mobile-friendly
  • RingOut Cons: No in-browser call controls, requires phone hardware/app
  • Embeddable Pros: In-browser calling, full call controls, no phone hardware needed
  • Embeddable Cons: Requires WebRTC, third-party JS, widget styling may not match, mobile support limited
Recommendation: Continue with RingOut for most organizations. Consider Embeddable only if organization moves away from desk phones or needs in-browser calling.

​
Finding 2: Call Controls Gap

Description: Current implementation lacks call controls (transfer, hold, mute) during active calls. Evidence:
  • No Call Control API integration in ringcentral-client.ts
  • No UI components for call controls
  • Receptionists cannot transfer calls within Encore Health OS
Impact:
  • Receptionists must use RingCentral app to transfer calls
  • Users cannot hold/mute calls during active sessions
  • Reduced productivity for call handling workflows
Recommendation: Create CE-03-E2: Call Transfer & Hold Controls if users need transfer capabilities. Effort: 3-5 days.

​
Finding 3: Voicemail Access Gap

Description: Users must access voicemail through RingCentral app; no in-app voicemail access. Evidence:
  • No voicemail integration in current implementation
  • RingCentral Message Store API not utilized for voicemail
  • Users must switch to RingCentral app for voicemail
Impact:
  • Reduced convenience (users must switch apps)
  • Voicemail not integrated with contact/partner records
  • No voicemail-to-activity auto-creation
Recommendation: Create CE-03-E3: Voicemail Integration if users want voicemail in-app. Effort: 2-3 days.

​
Finding 4: SMS Implementation Superior to Embeddable

Description: Current CE-08 SMS implementation is superior to Embeddable SMS widget. Evidence:
  • CE-08 has full control over UI/UX (matches design system)
  • TCPA compliance built-in with opt-out handling
  • PHI detection with configurable warn/block modes
  • Template system with merge fields
  • Consent management
  • Provider flexibility (RingCentral or Twilio)
  • Integrated with CE contacts/partners
Impact:
  • Better compliance and control
  • Superior user experience
  • More features than Embeddable SMS
Recommendation: Do not replace CE-08 with Embeddable SMS. Current implementation is superior.

​
Finding 5: rc-unified-crm-extension Not Applicable

Description: rc-unified-crm-extension is a Chrome/Edge browser extension framework, not applicable to web applications. Evidence:
  • Extension is designed for browser extensions, not web apps
  • Used for integrating RingCentral into third-party CRMs (Salesforce, HubSpot) via browser extension injection
  • Encore Health OS is a web application, not a browser extension
Impact:
  • Not relevant to Encore Health OS architecture
  • Different use case (third-party CRM integration)
Recommendation: Do not implement rc-unified-crm-extension. Not applicable to web application architecture.

​
Recommendations

​
High Priority

  1. Continue with Current RingOut Approach
    • Rationale: Production-ready, works with existing infrastructure, better audio quality, simpler implementation
    • Estimated Effort: No changes needed
    • Dependencies: None
    • Success Criteria: Current functionality continues to work as expected
  2. Add Call Controls (CE-03-E2) - If Needed
    • Rationale: Receptionists need transfer capabilities; users need hold/mute during calls
    • Estimated Effort: 3-5 days
    • Dependencies: RingCentral Call Control API, active call tracking
    • Success Criteria: Users can transfer, hold, and mute calls from Encore Health OS UI

​
Medium Priority

  1. Add Voicemail Access (CE-03-E3) - If Needed
    • Rationale: Convenience feature; integrates voicemail with contact records
    • Estimated Effort: 2-3 days
    • Dependencies: RingCentral Message Store API
    • Success Criteria: Users can access and play voicemails from Encore Health OS UI

​
Low Priority / Future Enhancements

  1. Full Embeddable Integration (CE-14) - 📋 PLANNED
    • Rationale: Many staff aren’t at desks; need in-browser calling for mobile/remote staff
    • Estimated Effort: 2-3 weeks (12-15 days)
    • Dependencies: CE-03 ✅, CE-03-E1 ✅, CE-08 ✅
    • Status: Specification complete (2026-01-28), ready for implementation
    • Success Criteria: In-browser WebRTC calling works with full call controls
    • Spec: specs/ce/specs/CE-14-ringcentral-embeddable.md
    • Plan: specs/ce/plans/CE-14-ringcentral-embeddable-PLAN.md
    • Tasks: specs/ce/tasks/CE-14-TASKS.md
  2. Presence/Status Integration
    • Rationale: Team visibility into user availability
    • Estimated Effort: Low (requires Presence API)
    • Dependencies: RingCentral Presence API
    • Success Criteria: Users can see team member availability status

​
Next Steps

  1. Document Analysis Complete
    • Owner: AI Agent
    • Timeline: Immediate
    • Deliverable: This analysis document
  2. Gather User Feedback
    • Owner: Product Owner / CE Module Owner
    • Timeline: Next sprint
    • Deliverable: User feedback on RingOut experience, need for call transfer, voicemail access
  3. Evaluate Call Transfer Need
    • Owner: Product Owner
    • Timeline: Based on user feedback
    • Deliverable: Decision on CE-03-E2 (Call Transfer & Hold Controls)
  4. Evaluate Voicemail Need
    • Owner: Product Owner
    • Timeline: Based on user feedback
    • Deliverable: Decision on CE-03-E3 (Voicemail Integration)
  5. Monitor for Embeddable Need
    • Owner: Product Owner
    • Timeline: Ongoing
    • Deliverable: Decision criteria met for CE-14 (Embeddable Integration)

​
Technical Architecture Comparison

​
Current Architecture (RingOut)

User clicks "Call" → ClickToCallButton
  → ringcentral-ringout edge function
    → RingCentral RingOut API
      → Rings user's phone
        → User answers
          → RingCentral connects to target
            → Webhook creates ce_calls record
              → Screen pop via Realtime
Pros:
  • Simple API integration
  • Works with existing infrastructure
  • No browser dependencies
  • Better audio quality
Cons:
  • No in-browser call controls
  • Requires phone hardware/app

​
Embeddable Architecture (If Implemented)

User clicks "Call" → postMessage to Embeddable
  → Embeddable widget (WebRTC)
    → Direct browser calling
      → Embeddable events
        → Screen pop via event listener
          → Call logging via webhook (existing)
Pros:
  • In-browser calling
  • Full call controls
  • No phone hardware needed
Cons:
  • Requires WebRTC (browser permissions)
  • Third-party JS in application
  • Widget styling may not match design system
  • Mobile support limited
  • More complex integration

​
Conclusion

Current Status: ✅ Production-ready implementation Key Strengths:
  • Complete call logging and management
  • Click-to-call via RingOut (works with existing phones)
  • Screen pop notifications with contact context
  • Full-featured SMS with compliance
  • Platform Telephony Integration Layer for reusability
Gaps (Optional Enhancements):
  • Call transfer/hold controls (add if needed)
  • Voicemail access (add if needed)
  • In-browser WebRTC calling (only if organization moves away from phones)
Recommendation: Continue with current approach. Add call controls or voicemail if user feedback indicates need. Consider Embeddable (CE-14) only if organization requires in-browser calling.

​
See Also

  • specs/ce/specs/CE-03-call-management-ringcentral.md - Base spec
  • specs/ce/specs/CE-03-E1-click-to-call-screen-pop.md - Enhancement spec
  • specs/ce/specs/CE-03-RINGCENTRAL-EMBEDDABLE-ANALYSIS.md - Embeddable analysis
  • specs/ce/specs/CE-08-sms-messaging-integration.md - SMS spec
  • specs/ce/IMPLEMENTATION_LOG.md - Implementation status
  • docs/architecture/integrations/PLATFORM_INTEGRATION_LAYERS.md - Platform Telephony Layer
  • RingCentral Developer Guide
  • RingCentral Embeddable Voice
  • RingOut API Guide
  • Call Control API Guide