SIP PBX icon

SIP PBX

Dial → Wait Event

AI-generated

Summary

Wait for a SIP PBX event to occur

Inputs

  • dialTimeoutSeconds — Maximum time to wait for the event before timing out, in seconds.
  • legId — Identifier of the master leg to retain during the wait; used to keep the leg alive and to subscribe to interrupt events.
  • interruptOn — Signal(s) that will cause the wait to end early; currently supports 'DTMF' (Dual‑Tone Multi‑Frequency).
  • waitEventOutputs — Additional event types to emit alongside the wait completion; options include 'ringing', 'progress', and 'rejected'.
  • dialIds — Explicit list of dial IDs to wait for; if empty the node waits for the input dialId then sipPbx.dialId.

Output shape

single event object

Emits the event data when the waited condition is met; empty if the timeout expires; additional outputs can be selected via Additional Outputs.

Examples

Example 1: Wait for a call on a specific leg to be interrupted by DTMF tones

dialTimeoutSeconds: 30, legId: 'leg_001', interruptOn: 'dtmf', waitEventOutputs: ['ringing','progress'], dialIds: {}

Example 2: Wait for multiple simultaneous dial operations and capture progress events

dialTimeoutSeconds: 45, legId: '', interruptOn: [], waitEventOutputs: ['progress'], dialIds: {item: ['dial-123','dial-456']}

Example 3: Wait for a call to ring and then emit a rejected signal if not answered

dialTimeoutSeconds: 20, legId: '', interruptOn: [], waitEventOutputs: ['rejected'], dialIds: {}

Links

Discussion