Strona główna -> Dokumentacja -> Szybki start

Szybki start: pierwszy działający webhook

Ten quickstart ma jeden cel: w kilka minut doprowadzić do sytuacji, w której IVR API wywołuje Twój endpoint, a Ty odsyłasz akcję (np. Play). Potem dokładamy kolejne kroki: DTMF, routing i stabilność.

Najprostszy test flow: Connected → Play → Hangup.

Krok 1: przygotuj endpoint webhook

Przyjmij HTTP POST.
Odczytaj JSON z pola request.
Zaloguj minimum: UniqueCallId + Event.EventName + czas odpowiedzi.
Zwróć JSON z Action oraz opcjonalnie Session.

Na starcie nie buduj „wielkiego silnika”. Najpierw stabilny ping-pong: event → odpowiedź → akcja.

Krok 2: ustawienia w panelu IVR API

Adres WWW aplikacji — URL Twojego webhooka (rekomendowane HTTPS).
Maksymalny czas oczekiwania — ustaw krótko (kilka sekund) i kontroluj timeouty.
Działanie awaryjne — co ma się stać przy timeout/błędzie (komunikat / kolejka / rozłączenie).
Hash (opcjonalnie) — weryfikacja wywołań (dobry standard od początku).
Połączenia na numery zewnętrzne — włącz tylko, jeśli potrzebujesz routingu poza pulę.

Dokładny opis pól request: Webhook: żądanie.

Krok 3: przetestuj odpowiedź „Play”

Gdy dostaniesz zdarzenie (np. Connected), odeślij najprościej akcję odtwarzającą zapowiedź.

{
  "Action": { "Type": "Play", "Prompt": "1" },
  "Session": { "step": "welcome" }
}

Prompt to numer zapowiedzi skonfigurowany w panelu IVR API. Jeśli chcesz sterować krokami — trzymaj licznik/krok w Session.

Krok 4: zakończ rozmowę „Hangup”

Po odegraniu komunikatu możesz zakończyć rozmowę akcją Hangup.

{
  "Action": { "Type": "Hangup" },
  "Session": { "step": "end" }
}

Co dalej: najczęstszy „produkcyjny” szkielet scenariusza

Connected → Play
GetDTMF (temat albo ID sprawy/zamówienia)
Lookup w CRM/helpdesku (priorytet, opiekun, SLA, status)
Routing: Call… do opiekuna / kolejki
CallStatus → fallback (Busy/Noanswer/timeout)

Następny krok w dokumentacji: Webhook: odpowiedź (Action/Session) oraz Akcje API (parametry).

Uruchom pierwszy test

Załóż konto, ustaw webhook i zrób pierwszy przepływ: Connected → Play → Hangup. Potem dokładamy DTMF i routing — już na działającej bazie.

Załóż konto Webhook: żądanie