Behavior
- Pauses execution for the configured duration
- Optionally plays a message during the wait
- Can be interrupted by the caller pressing a DTMF key
- Emits
WAIT.COMPLETEwhen the wait finishes orWAIT.ERRORon failure
Configuration
| Parameter | Type | Default | Range / Options | Description |
|---|---|---|---|---|
duration | number | 5 | 1–300 | Duration to wait |
unit | enum | "seconds" | seconds, minutes | Time unit for the duration |
interruptible | boolean | true | — | Allow the caller to interrupt the wait by pressing a DTMF key |
interruptKey | string | "#" | — | DTMF key that interrupts the wait |
playMessage | boolean | false | — | Play a message during the wait |
waitMessage | string | "" | — | Text message to play while waiting (requires playMessage: true) |
Output handles
| Handle | Description |
|---|---|
| Complete | Wait duration elapsed or caller interrupted |
| Error | An error occurred during the wait |
Use cases
Delay before transfer
Delay before transfer
Add a 2-second wait between a TTS message and a Transfer node to give the caller time to hear the full message.
Hold with message
Hold with message
Set
duration: 30, unit: "seconds", playMessage: true, and waitMessage: "Please hold while we connect you." to play a hold message.Interruptible wait
Interruptible wait
Wait 60 seconds with
interruptKey: "*". If the caller presses *, skip the wait and proceed immediately to the next node.