Check if a participant is on hold in Amazon Connect Agent Workspace

Checks whether a specific participant is currently on hold.

Signature

isParticipantOnHold(participantId: string): Promise<boolean>

Usage

const isOnHold = await voiceClient.isParticipantOnHold("participant-456");
if (isOnHold) {
  console.log("Participant is on hold");
} else {
  console.log("Participant is active");
}

Input

Output

Returns a Promise that resolves to a boolean: true if the participant is on hold, false otherwise