Skip to main content

Invite Interpreter

Use the Add an Interpreter popup to add an audio-only interpreter to an active video consultation.


This screen includes:

#ElementDescription
1InstructionsExplain how to request an interpreter
2Language selectorSelects the interpreter language
3Add interpreter actionSubmits the interpreter request
4Close actionDismisses the dialog

Workflow​

  1. Open an active video consultation.
  2. Select the interpreter action.
  3. Call PUT /api/v3/appointments/{appointment-id}/video-room/interpreter.
  4. Display the Invite Interpreter dialog.
  5. Select an interpreter language.
  6. Select Add interpreter.
  7. Call POST /api/v3/appointments/{appointment-id}/video-room/interpreter/invite.
  8. Add the interpreter to the consultation.

Validations​

ScenarioApp behaviorSDK output
No active consultationHide the interpreter actionstate = unavailable
No language selectedDisable Add interpreterstate = invalid
Valid language selectedEnable Add interpreterstate = valid
Interpreter already activeBlock another requeststate = unavailable
Session is invalidReject the requeststate = unauthenticated
Request failsPreserve the current consultationstate = error

Actions​

ScenarioApp behaviorSDK output
Interpreter action selectedDisplay the interpreter dialogPage object
Language selectedUpdate the selected languagelanguage = updated
Add interpreter selectedSubmit the interpreter requestPOST request
Interpreter joinsUpdate consultation participantsstate = connected
Close selectedDismiss the dialogClose event

Endpoint Resources​

Interpreter​

PUT 

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

Displays the Invite Interpreter dialog for the specified video consultation.

Request Interpreter​

POST 

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

Invites an audio-only interpreter to the active video consultation in the selected language