Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (n8n-nodes-ivrapi-beta) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
n8n-nodes-ivrapi — IVRAPI nodes for n8n (B2B)
Language / Język: Polski · English · Deutsch
🇵🇱 Wersja polska
Nowe community nodes dla n8n, które pozwalają dodać telefonię klasy operatorskiej do workflowów: click-to-call, warm transfer z voicebota do agenta, callback, rejestracja połączeń oraz integracja z CRM/Helpdesk.
Uwaga (B2B): Usługi IVRAPI są dostępne wyłącznie dla klientów biznesowych po podpisaniu umowy i aktywacji konta. Aby uzyskać dostęp do API oraz klucza, złóż wniosek na nodes.ivrapi.com.
Spis treści (PL)
- Co to jest IVRAPI
- Co jest w paczce
- Wymagania
- Instalacja
- Konfiguracja kredencjałów
- Szybki start (Click-to-Call)
- Dokumentacja
- Szablony (Templates)
- Cennik i umowa B2B
- Najczęstsze pytania (FAQ)
- Wsparcie i kontakt
- Wkład i rozwój (Contributing)
- Licencja i znaki towarowe
Co to jest IVRAPI
IVRAPI to platforma telekomunikacyjna dla automatyzacji rozmów i połączeń głosowych. Udostępnia REST API i gotowe nody do n8n, które skracają czas wdrożenia rozwiązań telefonicznych z tygodni do godzin.
Przykładowe zastosowania:
- Połączenie agent ↔ klient inicjowane z workflow (np. po zgłoszeniu leada na www),
- Warm transfer z voicebota do żywego agenta,
- Callback dla nieodebranych połączeń,
- Zapisywanie metadanych połączeń w CRM/Helpdesk, powiadomienia w Slack/Email.
Co jest w paczce
Każdy node ma przycisk Docs (pole
documentationUrl) prowadzący do szczegółowej dokumentacji na stronie.
| Node | Krótki opis |
|---|---|
| IVRAPI Voice Notification | Wykonuje połączenie wychodzące z komunikatem TTS (powiadomienia głosowe). |
| IVRAPI Voice Bot Call | Inicjuje połączenie z botem głosowym i umożliwia warm transfer do agenta. |
| IVRAPI Call Connect | Zestawia połączenie agent ↔ klient z konfiguracją numerów prezentowanych (CLI/CLIP). |
| IVRAPI SMS Send | Wysyła wiadomość SMS do wskazanego odbiorcy; obsługa Sender ID, parametrów i szablonów. |
| IVRAPI SMS Bot | Wysyła SMS; nadawca ustawiany na numer wirtualny bota odpowiadający na interakcję adresata; wsparcie szablonów. |
Wymagania
- n8n 1.0+ (Cloud lub Self-Hosted),
- Konto biznesowe IVRAPI z aktywnym kluczem API,
- Aktywne numery/zasoby zgodnie z umową.
Instalacja
1) n8n Cloud / n8n Desktop / Self-Hosted (UI):
- Settings → Community Nodes → Install i wpisz:
n8n-nodes-ivrapi.
2) Self-Hosted (CLI dla deweloperów):
npm install n8n-nodes-ivrapi
# zrestartuj n8n po instalacjiKonfiguracja kredencjałów
- Otwórz Credentials → New i wybierz IVRAPI API Key.
- Wklej klucz X-Api-Key otrzymany po aktywacji konta B2B.
- Kliknij Test – jeśli nie masz jeszcze aktywnego dostępu, zobaczysz komunikat z linkiem do wniosku na nodes.ivrapi.com.
Bezpieczeństwo: trzymaj klucz w n8n Credentials; nie przechowuj go w zmiennych workflow.
Szybki start (Click-to-Call)
Dodaj Webhook Trigger (metoda
POST).Dodaj node IVRAPI Call Connect i ustaw:
- Agent number:
+48600123456(przykład), - Customer number:
+48500111222(przykład), - CLI dla klienta (virtualNumber): numer wirtualny zarejestrowany na IVRAPI,
- CLI dla agenta (virtualNumber): numer wirtualny zarejestrowany na IVRAPI.
- Agent number:
Podepnij Credentials: IVRAPI API Key i zdeployuj workflow.
Dokumentacja
- Dokumentacja każdego noda: przycisk Docs w interfejsie n8n (pole
documentationUrl). - Przegląd rozwiązań, onboarding B2B i przykłady: nodes.ivrapi.com.
Szablony (Templates)
- Gotowe workflowy (JSON): Click-to-Call, Callback, Warm Transfer, Google Sheets → Outbound Call, Missed Call → Slack/Email.
- Po imporcie uzupełnij Credentials i identyfikatory/boty.
Cennik i umowa B2B
- Rozliczenie: abonament + stawki jednostkowe (minuty, połączenia, nagrywanie, TTS/STT itd.).
- Aktualne warunki, SLA i opcje kontraktowe: nodes.ivrapi.com/pricing.
Najczęstsze pytania (FAQ)
Czy mogę testować bez umowy? Obecnie wymagamy rejestracji B2B. Skontaktuj się w sprawie środowiska sandbox. Dlaczego instalacja wymaga Community Nodes? To standardowa metoda dodawania rozszerzeń w n8n. Błąd „Unknown/Unregistered number”. Użyj numerów zarejestrowanych w Twoim koncie IVRAPI.
Wsparcie i kontakt
- Strona i formularz: nodes.ivrapi.com
- Zgłoszenia: Issues w repo lub formularz na stronie.
Dane do faktur (B2B): ADVICOS POLAND sp. z o.o. ul. Leśna 56, 87-125 Silno, Polska EU VAT ID: PL8792707586
Wkład i rozwój (Contributing)
- Aktualizuj README/changelog i przykłady workflow przy każdym PR.
- Sprawdzaj opisy i walidacje parametrów w nodach.
Licencja i znaki towarowe
Licencja paczki: (uzupełnij: MIT/Apache-2.0/inna). „n8n” jest znakiem towarowym odpowiedniego właściciela. Paczka jest tworzona przez społeczność i stosuje wytyczne dot. użycia marki n8n.
🇬🇧 English version
Community nodes for n8n that add carrier-grade telephony to your workflows: click-to-call, warm transfer from voicebot to live agent, callback, call logging, and CRM/Helpdesk integrations.
Note (B2B): IVRAPI services are available to business customers only, under a signed agreement. To obtain API access and a key, request access at nodes.ivrapi.com. Availability: Production-ready for Poland; we’re open to interested teams across the European Union. Contact us to discuss numbering options and regulatory compliance in your country.
Table of contents (EN)
- What is IVRAPI
- What’s included
- Requirements
- Installation
- Credentials setup
- Quick start (Click-to-Call)
- Documentation
- Templates
- Pricing & B2B agreement
- FAQ
- Support & contact
- Contributing
- License & trademarks
What is IVRAPI
IVRAPI is a telecom platform for automating voice calls and conversations. It provides a REST API and ready-made n8n nodes to reduce telephony implementation from weeks to hours.
Example use cases:
- Agent ↔ customer connection initiated from a workflow (e.g., after a web lead),
- Warm transfer from a voicebot to a live agent,
- Callback for missed calls,
- Logging call metadata in CRM/Helpdesk, Slack/Email notifications.
What’s included
Each node exposes a Docs link (
documentationUrl) that opens detailed documentation on our site.
| Node | Short description |
|---|---|
| IVRAPI Voice Notification | Outbound call with a TTS message (voice notifications). |
| IVRAPI Voice Bot Call | Initiates a voicebot call and enables warm transfer to a live agent. |
| IVRAPI Call Connect | Bridges agent ↔ customer with configurable caller ID presentation (CLI/CLIP). |
| IVRAPI SMS Send | Sends an SMS to a recipient; supports Sender ID, parameters, and templates. |
| IVRAPI SMS Bot | Sends SMS; sender set to the bot’s virtual number that handles the recipient’s replies; supports templates. |
Requirements
- n8n 1.0+ (Cloud or Self-Hosted),
- IVRAPI business account with an active API key,
- Active numbers/resources as per your agreement.
Installation
1) n8n Cloud / Desktop / Self-Hosted (UI):
- Settings → Community Nodes → Install and enter:
n8n-nodes-ivrapi.
2) Self-Hosted (developer CLI):
npm install n8n-nodes-ivrapi
# restart n8n after installationCredentials setup
- Go to Credentials → New and select IVRAPI API Key.
- Paste your X-Api-Key provided after B2B activation.
- Click Test – if your access isn’t active yet, you’ll see a message with a link to the request form on nodes.ivrapi.com.
Security: store the key in n8n Credentials; do not keep it in workflow variables.
Quick start (Click-to-Call)
Add Webhook Trigger (
POST).Add IVRAPI Call Connect and configure:
- Agent number:
+48600123456(example), - Customer number:
+48500111222(example), - Customer CLI (virtualNumber): a number registered in your IVRAPI account,
- Agent CLI (virtualNumber): a number registered in your IVRAPI account.
- Agent number:
Attach Credentials: IVRAPI API Key and deploy the workflow.
Documentation
- Per-node docs: Docs link in n8n UI (
documentationUrl). - Solutions overview, B2B onboarding, and examples: nodes.ivrapi.com.
Templates
- Ready-to-use workflows (JSON): Click-to-Call, Callback, Warm Transfer, Google Sheets → Outbound Call, Missed Call → Slack/Email.
- After import, fill in Credentials and any IDs/bot settings.
Pricing & B2B agreement
- Billing model: subscription + usage (minutes/calls, recording, TTS/STT, etc.).
- Current terms, SLA and options: nodes.ivrapi.com/pricing.
FAQ
Can I test without a contract? Currently we require B2B registration. Contact us about sandbox access. Why Community Nodes? It’s the standard way to add extensions to n8n. “Unknown/Unregistered number” error. Use numbers registered in your IVRAPI account.
Support & contact
- Website & contact form: nodes.ivrapi.com
- Issues: GitHub Issues (repo link coming soon) or the website form.
Invoicing details: ADVICOS POLAND sp. z o.o. ul. Leśna 56, 87-125 Silno, Poland EU VAT ID: PL8792707586
Contributing
- Update README/changelog and workflow examples with each PR.
- Verify parameter descriptions and validations in nodes.
License & trademarks
Package license: (fill in: MIT/Apache-2.0/other). “n8n” is a trademark of its respective owner. This community-driven package follows the n8n brand usage guidelines.
🇩🇪 Deutsche Version
Community-Nodes für n8n, mit denen Sie Carrier-Grade-Telefonie in Ihre Workflows integrieren: Click-to-Call, Warm Transfer vom Voicebot zum Live-Agenten, Callback, Anrufprotokollierung sowie CRM/Helpdesk-Integrationen.
Hinweis (B2B): IVRAPI-Dienste sind ausschließlich für Geschäftskunden und erfordern einen unterzeichneten Vertrag. API-Zugang erhalten Sie über nodes.ivrapi.com. Verfügbarkeit: Produktionsreif für Polen; offen für Interessenten in der gesamten Europäischen Union. Kontaktieren Sie uns, um Optionen für Rufnummern und regulatorische Anforderungen (z. B. DSGVO, Anrufaufzeichnung) in Ihrem Land zu besprechen.
Inhaltsverzeichnis (DE)
- Was ist IVRAPI
- Inhalt des Pakets
- Voraussetzungen
- Installation
- Anmeldedaten (Credentials)
- Schnellstart (Click-to-Call)
- Dokumentation
- Vorlagen (Templates)
- Preise & B2B-Vertrag
- FAQ
- Support & Kontakt
- Beiträge & Entwicklung (Contributing)
- Lizenz & Marken
Was ist IVRAPI
IVRAPI ist eine Telekommunikationsplattform zur Automatisierung von Sprachanrufen und Sprachdialogen. Sie bietet ein REST-API und fertige n8n-Nodes, um Telefonie-Implementierungen von Wochen auf Stunden zu verkürzen.
Beispiele:
- Agent ↔ Kunde aus einem Workflow heraus verbinden (z. B. nach einem Web-Lead),
- Warm Transfer vom Voicebot zum Live-Agenten,
- Callback für verpasste Anrufe,
- Protokollierung von Anruf-Metadaten in CRM/Helpdesk, Benachrichtigungen in Slack/E-Mail.
Inhalt des Pakets
Jeder Node enthält einen Docs-Link (
documentationUrl) zur Detaildokumentation auf unserer Website.
| Node | Kurzbeschreibung |
|---|---|
| IVRAPI Voice Notification | Ausgehender Anruf mit TTS-Ansage (Sprachbenachrichtigungen). |
| IVRAPI Voice Bot Call | Startet einen Voicebot-Anruf und ermöglicht Warm Transfer zum Live-Agenten. |
| IVRAPI Call Connect | Verbindet Agent ↔ Kunde mit konfigurierbarer Anruferkennung/Rufnummernübermittlung (CLI/CLIP). |
| IVRAPI SMS Send | Sendet eine SMS an den Empfänger; unterstützt Sender ID, Parameter und Textvorlagen. |
| IVRAPI SMS Bot | Sendet SMS; der Absender wird auf die virtuelle Bot-Nummer gesetzt, die die Antworten des Empfängers verarbeitet; unterstützt Vorlagen. |
Voraussetzungen
- n8n 1.0+ (Cloud oder Self-Hosted),
- IVRAPI-Geschäftskonto mit aktivem API-Schlüssel,
- Aktive Nummern/Ressourcen gemäß Vertrag.
Installation
1) n8n Cloud / Desktop / Self-Hosted (UI):
- Settings → Community Nodes → Install und
n8n-nodes-ivrapieingeben.
2) Self-Hosted (Entwickler-CLI):
npm install n8n-nodes-ivrapi
# n8n nach der Installation neu startenAnmeldedaten (Credentials)
- Credentials → New öffnen und IVRAPI API Key wählen.
- Ihren X-Api-Key einfügen (nach B2B-Aktivierung).
- Test klicken – ohne aktiven Zugang erscheint ein Hinweis mit Link zum Formular auf nodes.ivrapi.com.
Sicherheit: Schlüssel in n8n Credentials speichern; nicht in Workflow-Variablen.
Schnellstart (Click-to-Call)
Webhook Trigger hinzufügen (
POST).IVRAPI Call Connect konfigurieren:
- Agent number:
+48600123456(Beispiel), - Customer number:
+48500111222(Beispiel), - Customer CLI (virtualNumber): registrierte Nummer in Ihrem IVRAPI-Konto,
- Agent CLI (virtualNumber): registrierte Nummer in Ihrem IVRAPI-Konto.
- Agent number:
Credentials: IVRAPI API Key zuweisen und Workflow deployen.
Dokumentation
- Pro-Node-Doku: Docs-Link in der n8n-UI (
documentationUrl). - Überblick, B2B-Onboarding und Beispiele: nodes.ivrapi.com.
Vorlagen (Templates)
- Fertige Workflows (JSON): Click-to-Call, Callback, Warm Transfer, Google Sheets → Outbound Call, Missed Call → Slack/E-Mail.
- Nach dem Import Credentials sowie IDs/Bot-Einstellungen ausfüllen.
Preise & B2B-Vertrag
- Abrechnung: Abo + nutzungsbasiert (Minuten/Anrufe, Aufzeichnung, TTS/STT etc.).
- Aktuelle Konditionen, SLA und Optionen: nodes.ivrapi.com/pricing.
FAQ
Kann ich ohne Vertrag testen? Derzeit ist B2B-Registrierung erforderlich. Kontaktieren Sie uns für Sandbox-Zugang. Warum Community Nodes? Dies ist der Standardweg, Erweiterungen zu n8n hinzuzufügen. Fehler „Unknown/Unregistered number“. Verwenden Sie Nummern, die in Ihrem IVRAPI-Konto registriert sind.
Support & Kontakt
- Website & Kontaktformular: nodes.ivrapi.com
- Issues: GitHub-Issues (Repo-Link folgt) oder das Formular auf der Website.
Rechnungsdaten: ADVICOS POLAND sp. z o.o. ul. Leśna 56, 87-125 Silno, Polen EU VAT ID: PL8792707586
Beiträge & Entwicklung (Contributing)
- README/Changelog und Workflow-Beispiele bei jedem PR aktualisieren.
- Parameterbeschreibungen und Validierungen in den Nodes prüfen.
Lizenz & Marken
Paketlizenz: (ausfüllen: MIT/Apache-2.0/anderes). „n8n“ ist eine Marke des jeweiligen Eigentümers. Dieses Community-Paket folgt den n8n-Brand-Richtlinien.