Iframe Embedding Requirements

Overview

To embed HAMI within your application using an <iframe>, you must configure specific browser permissions and ensure proper network connectivity. Incorrect configuration will prevent core features like microphone access and real-time audio from functioning.

1. Iframe Configuration

Caution

The allow attribute is required. Without allow="microphone", the browser will block microphone access inside the iframe entirely, regardless of what the user allows at the OS or browser level.

The <iframe> tag must include the specified permissions. Replace {groupName} with your configured clinic or hospital’s name (e.g., baytown).

Note

The width, height, and style values shown below are for example purposes only. Adjust them to fit your website’s layout and design requirements.

<iframe
  src="https://careflow.bostonhealth.ai/g/{groupName}"
  title="{groupName}"
  width="390"
  height="630"
  style="border:0; border-radius:12px; max-width:calc(100vw - 2rem); max-height:calc(100vh - 2rem); display:block;"
  loading="lazy"
  referrerpolicy="strict-origin-when-cross-origin"
  allow="microphone; camera; autoplay; clipboard-write; geolocation"
  allowfullscreen
></iframe>

Permission	Required	Description
microphone	Yes	Required for real-time audio input during patient intake
autoplay	Yes	Required for AI avatar audio playback
camera	Recommended	Optional, recommended for future-proofing
clipboard-write	No	Enables copy-to-clipboard functionality
geolocation	Yes	Enables location-based features

2. Network Connectivity

The embedded application makes outbound connections from the patient’s browser to several services. Ensure none of these are blocked by your network or firewall configuration.

Service	Protocol	Notes
REST API	HTTPS	Must be reachable from the patient’s browser
WebSocket	WSS	Must not be blocked by corporate firewalls
Real-time audio server	UDP/TCP	Requires open ports for real-time communication
Country flag CDN (flagcdn.com)	HTTPS	Used for country flag images in the phone number input

Caution

If patients are behind a strict corporate firewall or proxy, real-time audio may fail silently. Test the integration from the patient’s network environment before going live.

Support

For additional support or questions about iframe embedding:

• Email: support@bostonhealth.ai
• Website: bostonhealth.ai