Subscribe to participant disconnected events in Amazon Connect Agent Workspace
Subscribes to participant disconnected events. This event fires when a participant leaves or is removed from a contact.
Signature
onParticipantDisconnected(handler: ParticipantDisconnectedHandler, contactId?: string): void
Usage
const handleParticipantDisconnected = (event) => { console.log(`Participant disconnected: ${event.participant.participantId}`); }; contactClient.onParticipantDisconnected( handleParticipantDisconnected, "contact-123" );
Input
| Parameter | Type | Description |
|---|---|---|
| handler Required | ParticipantDisconnectedHandler | Event handler function to call when participants disconnect |
| contactId | string | Optional contact ID to filter events for a specific contact |
Event Structure - ParticipantDisconnected
The handler receives a ParticipantDisconnected event with:
-
participant: ParticipantData - The participant that was disconnected
Permissions required:
Contact.Details.View