Skip to main content

Invite Interpreter


Use Invite Interpreter to add an audio-only interpreter to an active video consultation.
This screen supports real-time interpretation when the doctor and patient speak different languages.
The interpreter joins the session without video.


This screen includes

  • A modal dialog that appears during an active video consultation.
  • Instructional text that explains the interpreter role and translation direction.
  • A required Preferred interpreter language selector.
  • An Add an interpreter action that activates after language selection.
  • A close control that exits without changes.
  • The active video call visible in the background.

Workflow

Add an Interpreter

important

You can invite an interpreter only during an active video consultation.

  1. During a video call, select the Interpreter icon in the bottom toolbar.
    Interpreter icon in the video call toolbar
  2. Review the message that explains the interpreter purpose and translation direction.
  3. From Preferred interpreter language, select the patient language.
  4. Select Add an interpreter.
  5. Confirm that the dialog closes and the interpreter joins the session.

Cancel

  1. In the Invite Interpreter dialog, select the close icon (X).
  2. Confirm that the dialog closes and the consultation continues unchanged.

Validations

These scenarios describe how the app validates the Invite Interpreter screen and what the integrator can expect.

ScenarioApp BehaviorSDK OutputExample
The consultation is not active.The app does not display the interpreter dialog.No request is sent.
No interpreter language is selected.The app keeps Add an interpreter disabled.No request is sent.
A valid language is selected.The app enables Add an interpreter.Ready state for invite request.
The user closes the dialog.The app dismisses the dialog without changes.No update to session state.
note

The video call continues in the background while the dialog is open.

Actions

These scenarios describe how the app responds to actions in the Invite Interpreter dialog and what the SDK returns.

ScenarioApp BehaviorSDK OutputExample
The doctor selects Add an interpreter.The app adds an audio-only interpreter to the session.Server-side confirmation; session state reflects interpreter presence.
The doctor selects the close control.The app dismisses the dialog without adding an interpreter.No session update.

Endpoint Resources

Present Interpreter Dialog

PUT 

/appointments/{appointment-id}/video-room/interpreter

Produces the Invite Interpreter dialog for the specified video session.

Invite Interpreter

POST 

/appointments/{appointment-id}/video-room/interpreter/invite

Invites an interpreter to join the active video consultation using the selected language.