Dokumentacja węzłów sekwencji głosowej

Ostrzeżenie: Sekwencje głosowe są w wersji zapoznawczej. Kroki, dane wejściowe i format definicji sekwencji mogą się zmienić w sposób, który zepsuje istniejące sekwencje i żądania API.

Użyj tej dokumentacji, aby napisać sequence.definition, który wysyłasz za pomocą Create Call. Bird uruchamia definicję inline jednorazowo i nie zapisuje jej. Aby zachować sekwencję, zbuduj ją w edytorze dashboardu.

Definicja

Każdy węzeł ma następujące pola:

Połączenia nie mogą tworzyć pętli, a każdy węzeł musi być osiągalny z punktu wejścia. Wynik pominięty w connections jest niepodłączony. Niepodłączone wyniki kończą przebieg normalnie, chyba że węzeł określa inaczej.

Wartości i wyrażenia

Większość pól przyjmuje literalne JSON. Pola oznaczone binds przyjmują również $expr lub $template; pola oznaczone expr przyjmują również wyłącznie $expr:

• {"$expr": "trigger.data.customer_name"} zwraca wartość typowaną.
• {"$template": ["Hello ", {"$expr": "trigger.data.customer_name"}, "."]} zwraca tekst. Szablony są tablicami; {{name}} pozostaje tekstem literalnym.

Wyrażenia używają CEL i mogą odczytywać następujące wartości:

Zabezpiecz wartości opcjonalne przed ich odczytaniem, na przykład has(trigger.data.name) ? trigger.data.name : 'caller'. Makro has jest dostępne; map, filter, all, exists i exists_one nie są dostępne.

Wejście

trigger.start_call

Miejsce, w którym połączenie się rozpoczyna. entry_node_id w żądaniu Create Call wskazuje ten węzeł.

Dane wejściowe są ograniczone do 16 KiB.

Mowa i dźwięk

voice.say

voice.play

voice.tone

logic.pause

Czeka z aktywnym połączeniem.

Wprowadzanie z klawiatury

voice.gather

Odtwarza komunikaty, które naciśnięcie klawisza przerywa, i zbiera cyfry z klawiatury.

Logika i dane

logic.branch

Sprawdza warunki po kolei i wybiera pierwszy spełniony.

data.set

Zapisuje wartości dla późniejszych kroków w tej samej wizycie.

Połączenia i przekierowania

voice.dial

Dzwoni pod numer telefonu lub numer w jednym z przychodzących trunków SIP Twojego obszaru roboczego albo wywołuje grupę dzwonienia i łączy go z bieżącym połączeniem. Użyj type_version 3.

Wersja 2 nie ma celu ring_group i zawsze wymaga timeout_seconds. Każde wejście poprawne w wersji 2 jest też poprawne w wersji 3, więc aktualizacja kroku niczego więcej nie zmienia.

Wersja 1 przyjmuje numer w input.to i nie ma orig. Kroki, które jej używają, nadal działają. Gdy zaktualizujesz krok w wersji 1 w edytorze, jego wartość to zostanie przeniesiona do pstn.dest.

logic.voice_goto

Uruchamia inne wejście w tej samej definicji. Nowa wizyta otrzymuje nowe trigger.data i czyści wyjścia oraz zmienne wcześniejszych kroków; połączenie trwa dalej.

Automations

automation.send_event

Wysyła zdarzenie aplikacji do automatyzacji bez czekania na przebieg. Połączenie trwa dalej, gdy tylko zdarzenie trafi do kolejki; to, czy przebieg się rozpoczął, widać tylko w Automations.

Kończenie połączenia

logic.exit

Kończy połączenie z wynikiem.

voice.hangup

Kończy połączenie bez zdefiniowanego wyniku. Nie ma pól ani wyników.

Informacje o voice.webhook znajdziesz w artykule Użyj danych aplikacji w sekwencji głosowej.

Przykład: przekierowanie do osoby

Ta definicja wita odbiorcę, wybiera numer wsparcia i rejestruje, czy przekierowanie zostało połączone:

{
  "schema_version": 1,
  "expression_environment": "bird.cel.v1",
  "nodes": [
    {
      "id": "start",
      "type": "trigger.start_call",
      "type_version": 1,
      "config": {},
      "input": {},
      "connections": { "event": { "node_id": "greeting", "port": "input" } }
    },
    {
      "id": "greeting",
      "type": "voice.say",
      "type_version": 1,
      "config": {},
      "input": { "text": "Connecting you to our support team.", "language": "en" },
      "connections": { "next": { "node_id": "support", "port": "input" } }
    },
    {
      "id": "support",
      "type": "voice.dial",
      "type_version": 3,
      "config": {},
      "input": { "type": "pstn", "pstn": { "dest": "+12025550123" }, "timeout_seconds": 30 },
      "connections": {
        "success": { "node_id": "connected", "port": "input" },
        "busy": { "node_id": "unavailable", "port": "input" },
        "no_answer": { "node_id": "unavailable", "port": "input" },
        "failure": { "node_id": "unavailable", "port": "input" }
      }
    },
    {
      "id": "connected",
      "type": "logic.exit",
      "type_version": 1,
      "config": { "status": "succeeded", "reason": "transferred" },
      "input": { "output": {} }
    },
    {
      "id": "unavailable",
      "type": "logic.exit",
      "type_version": 1,
      "config": { "status": "failed", "reason": "support_unavailable" },
      "input": { "output": {} }
    }
  ]
}

Wyślij ją jako sequence.definition z "entry_node_id": "start" i "trigger_data": {}.