Skip to content

Home

Jump to bottom
Andrey Egorov edited this page May 18, 2026 · 6 revisions

This wiki is the user-facing reference for n8n-nodes-sip-pbx.

The package adds two community nodes to self-hosted n8n:

  • SIP PBX Trigger
  • SIP PBX

Together they turn n8n into a daemon-backed SIP and media control surface for:

  • inbound trunk calls
  • SIP extension registration and extension-originated calls
  • outbound SIP dialing
  • outbound WebSocket media legs
  • IVR and DTMF routing
  • playback, recording, and media orchestration
  • call bridging and unbridging
  • queue routing and queue stats
  • voice-agent and AI tool workflows

What This Documentation Covers

This wiki documents the public node contract exposed to users:

  • every trigger mode
  • every action operation
  • all visible node parameters and options
  • branch behavior and output payloads
  • identifier resolution rules
  • WebSocket and AI integration modes
  • common end-to-end workflow patterns
  • operational caveats and troubleshooting

Where behavior matters, this documentation follows the code and the repository test suite.

Recommended Reading Order

  1. Installation and Requirements
  2. Core Concepts
  3. SIP Connection Credential
  4. SIP PBX Trigger Overview
  5. Trunk Event Trigger
  6. Extension Event Trigger
  7. Queue Event Trigger
  8. AI Tool Call Trigger
  9. SIP PBX Call Actions
  10. SIP PBX Dial Actions
  11. SIP PBX Media Actions
  12. SIP PBX Queue Actions
  13. SIP PBX Global Recording
  14. AI and WebSocket Legs
  15. Scenarios and Recipes
  16. Demo Walkthrough
  17. Troubleshooting

Quick Summary

The runtime revolves around a small set of stable identifiers:

  • legId for live call legs
  • dialId for outbound dial sessions
  • mediaId for playback and recording jobs
  • authRequestId, recordRequestId, aiToolRequestId for request-response workflows
  • ref for user-defined public trigger groups

From a workflow point of view, most node chaining is built around these rules:

  • triggers emit json payloads plus json.sipPbx metadata
  • actions usually accept explicit IDs first, then fall back to the current item
  • media can run in blocking or background mode
  • queue routing is daemon-owned, not workflow-owned
  • WebSocket legs behave like normal PBX legs and can be bridged, waited on, and controlled

AI and WebSocket Legs documents:

  • Dial -> Make Call in Mode = WebSocket
  • AI -> Attach Voice Agent
  • AI -> Invoke AI Tool

Current Scope and Practical Limits

  • This package is intended for self-hosted n8n.
  • The published package ships native prebuilds for Linux only.
  • The node UI currently exposes UDP for SIP credentials and extensions transport selection.
  • GitHub Wiki is the canonical place for end-user documentation, but the files in the repository wiki/ directory are written so they can be copied there directly.

Support References

Overview

Trigger

Actions

Advanced

Clone this wiki locally