Skip to main content

Remove Interpreter


Use the Remove Interpreter dialog to disconnect an interpreter from an active video consultation.


This screen includes:

#ElementDescription
1Confirmation messageRequests confirmation to remove the interpreter
2Yes actionDisconnects the interpreter
3No actionKeeps the interpreter connected
4Close actionDismisses the dialog

Workflow​

  1. Open an active video consultation with an interpreter.
  2. Select the interpreter removal action.
  3. Call PUT /api/v3/appointments/{appointment-id}/video-room/interpreter/hangup.
  4. Display the confirmation dialog.
  5. Select Yes to remove the interpreter.
  6. Call POST /api/v3/appointments/{appointment-id}/video-room/interpreter/hangup.
  7. Update the video consultation without the interpreter.

Validations​

ScenarioApp behaviorSDK output
No interpreter is activeHide the removal actionstate = unavailable
Interpreter is activeEnable the removal actionstate = available
Removal is not confirmedKeep the interpreter connectedstate = unchanged
Session is invalidReject the requeststate = unauthenticated
Request failsKeep the current session statestate = error

Automatic Disconnect​

ConditionApp behavior
Video consultation endsDisconnect the interpreter
Interpreter reaches the inactivity limitDisconnect the interpreter

Actions​

ScenarioApp behaviorSDK output
Removal action selectedDisplay the confirmation dialogPage object
Yes selectedDisconnect the interpreterstate = removed
No selectedDismiss the dialogstate = unchanged
Close selectedDismiss the dialogClose event

Endpoint Resources​

Hangup Interpreter​

PUT 

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

Displays the interpreter removal confirmation dialog for the specified video consultation.

note

This endpoint displays the confirmation dialog. The interpreter remains connected until the user confirms removal.

Remove Interpreter​

POST 

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

Disconnects the interpreter from the active video consultation.