SIP PBXInstall

Summary

Play a tone or custom audio pattern on a SIP leg.

Inputs

• tone (required) — Built-in tone preset or custom pattern.
• customTone (required) — Syntax: /,... Use + to mix frequencies and 0 for silence. Presets: Ringback: 440+480/2000,0/4000 | Busy: 480+620/500,0/500 | Congestion: 480+620/250,0/250.
• repeatInfinite — Repeat the tone indefinitely.
• interruptOn — Interrupt playback on DTMF or voice detection.
• legId — Identifier of the SIP leg to play media on.
• stopOtherMedia — Stop other active media on the same leg before starting this one.
• duckingFactor — Attenuation factor for concurrent mix; 1 leaves mix unchanged, values above 1 boost this playback.
• mediaExecutionMode — Execution mode: blocking or background.
• voiceThreshold — Minimum voice amplitude to trigger interruption.
• voiceDurationMs — Length of voice detection to trigger interruption (ms).

Output shape

no body — success/failure only

Returns nothing on success; errors are propagated as n8n execution errors.

Examples

Example 1: Play the default ringback tone once

Set Tone to "ringback", leave Custom Tone empty, repeatInfinite false, and use default options.

Example 2: Play a custom tone indefinitely and stop other media

Set Tone to "custom", provide Custom Tone value "440+480/2000,0/4000", enable Repeat Forever, setInterruptOn to ["voice"], and optionally set Options → Stop Other Media true.

Example 3: Play a busy tone in background mode

Set Tone to "busy", set Repeat Infinite false, Execution Mode to "background", and add a Leg ID of "5001".

Links

• n8n community nodes installation guide