Referenz der Voice-Sequence-Nodes

Warnung: Voice Sequences befinden sich in der Vorschau. Schritte, Entry-Daten und das Format der Sequence-Definition können sich so ändern, dass bestehende Sequences und API-Requests nicht mehr funktionieren.

Verwenden Sie diese Referenz, um die sequence.definition zu schreiben, die Sie mit Anruf erstellen senden. Bird führt eine Inline-Definition einmalig aus und speichert sie nicht. Um eine Sequence dauerhaft zu behalten, erstellen Sie sie im Dashboard-Editor.

Definition

Jeder Node hat diese Felder:

Verbindungen dürfen keine Schleife bilden, und jeder Knoten muss von einem Einstiegspunkt aus erreichbar sein. Ein Outcome, das in connections fehlt, ist nicht verbunden. Nicht verbundene Outcomes beenden den Durchlauf normal, sofern ein Knoten nichts anderes vorgibt.

Werte und Ausdrücke

Die meisten Felder akzeptieren literale JSON. Mit binds gekennzeichnete Felder akzeptieren auch $expr oder $template; mit expr gekennzeichnete Felder akzeptieren nur $expr:

• {"$expr": "trigger.data.customer_name"} gibt einen typisierten Wert zurück.
• {"$template": ["Hello ", {"$expr": "trigger.data.customer_name"}, "."]} gibt Text zurück. Templates sind Arrays; {{name}} bleibt literaler Text.

Ausdrücke verwenden CEL und können diese Werte lesen:

Prüfen Sie optionale Werte, bevor Sie sie lesen, zum Beispiel has(trigger.data.name) ? trigger.data.name : 'caller'. Das Makro has ist verfügbar; map, filter, all, exists und exists_one sind es nicht.

Entry

trigger.start_call

Hier beginnt ein Anruf. entry_node_id im Create-Call-Request benennt diesen Knoten.

Eingabedaten sind auf 16 KiB begrenzt.

Sprache und Audio

voice.say

voice.play

voice.tone

logic.pause

Wartet bei verbundenem Anruf.

Tastatureingabe

voice.gather

Spielt Ansagen ab, die ein Tastendruck unterbricht, und sammelt Tastatureingaben.

Logik und Daten

logic.branch

Prüft Bedingungen der Reihe nach und folgt der ersten, die zutrifft.

data.set

Speichert Werte für spätere Schritte im selben Visit.

Anrufe und Weiterleitungen

voice.dial

Ruft eine Telefonnummer oder eine Nummer auf einem der eingehenden SIP-Trunks Ihres Workspace an oder lässt eine Ring Group klingeln und verbindet sie mit dem aktuellen Anruf. Verwenden Sie type_version 3.

Version 2 hat kein ring_group-Ziel und erfordert immer timeout_seconds. Jede Eingabe für Version 2 ist auch in Version 3 gültig. Ein Upgrade eines Schritts ändert daher sonst nichts.

Version 1 erwartet die Nummer in input.to und hat kein orig. Schritte, die diese Version verwenden, laufen weiter. Wenn Sie einen Schritt der Version 1 im Editor upgraden, wird sein to-Wert nach pstn.dest verschoben.

logic.voice_goto

Startet einen weiteren Entry in derselben Definition. Der neue Visit erhält frische trigger.data und löscht die Ausgaben und Variablen vorheriger Schritte; der Anruf läuft weiter.

Automations

automation.send_event

Sendet ein Anwendungsereignis an eine Automation, ohne auf einen Durchlauf zu warten. Der Anruf läuft weiter, sobald das Ereignis in die Warteschlange gestellt ist. Ob ein Durchlauf startet, sehen Sie nur in Automations.

Anruf beenden

logic.exit

Beendet den Anruf mit einem Ergebnis.

voice.hangup

Beendet den Anruf ohne ein verfasstes Ergebnis. Der Knoten hat keine Felder und keine Outcomes.

Informationen zu voice.webhook finden Sie unter Anwendungsdaten in einer Voice Sequence verwenden.

Beispiel: Weiterleitung an eine Person

Diese Definition begrüßt den Empfänger, wählt eine Supportnummer und protokolliert, ob die Weiterleitung verbunden wurde:

{
  "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": {} }
    }
  ]
}

Senden Sie sie als sequence.definition mit "entry_node_id": "start" und "trigger_data": {}.