Référence des nœuds de séquence vocale

Avertissement : les séquences vocales sont en préversion. Les étapes, les données d'entrée et le format de définition des séquences peuvent changer de manière incompatible avec les séquences et requêtes API existantes.

Utilisez cette référence pour écrire le sequence.definition que vous envoyez avec Créer un appel. Bird exécute une définition en ligne une seule fois sans la sauvegarder. Pour conserver une séquence, construisez-la dans l'éditeur du tableau de bord.

Définition

Chaque nœud possède ces champs :

Les connexions ne doivent pas former de boucle, et chaque nœud doit être accessible depuis une entrée. Un résultat absent de connections est non connecté. Les résultats non connectés terminent l'exécution normalement, sauf indication contraire du nœud.

Valeurs et expressions

La plupart des champs acceptent des JSON littéraux. Les champs marqués binds acceptent aussi $expr ou $template ; les champs marqués expr acceptent aussi $expr uniquement :

• {"$expr": "trigger.data.customer_name"} renvoie une valeur typée.
• {"$template": ["Hello ", {"$expr": "trigger.data.customer_name"}, "."]} renvoie du texte. Les templates sont des tableaux ; {{name}} reste du texte littéral.

Les expressions utilisent CEL et peuvent lire ces valeurs :

Vérifiez les valeurs optionnelles avant de les lire, par exemple has(trigger.data.name) ? trigger.data.name : 'caller'. La macro has est disponible ; map, filter, all, exists et exists_one ne le sont pas.

Entrée

trigger.start_call

Point de départ d'un appel. entry_node_id dans la requête Create Call désigne ce nœud.

Les données d'entrée sont limitées à 16 Kio.

Parole et audio

voice.say

voice.play

voice.tone

logic.pause

Attend avec l'appel connecté.

Saisie au clavier

voice.gather

Joue des invites, qu'une pression de touche interrompt, et collecte les chiffres saisis au clavier.

Logique et données

logic.branch

Vérifie les conditions dans l'ordre et suit la première qui est vraie.

data.set

Enregistre des valeurs pour les étapes suivantes de la même visite.

Appels et transferts

voice.dial

Appelle un numéro de téléphone ou un numéro sur l'un des trunks SIP entrants de votre espace de travail, ou fait sonner un groupe de sonnerie, puis le connecte à l'appel en cours. Utilisez type_version 3.

La version 2 n'a pas de cible ring_group et exige toujours timeout_seconds. Toute entrée valide en version 2 l'est aussi en version 3 : la mise à niveau d'une étape ne change donc rien d'autre.

La version 1 prend le numéro dans input.to et n'a pas de orig. Les étapes qui l'utilisent continuent de fonctionner. Lorsque vous mettez à niveau une étape en version 1 dans l'éditeur, sa valeur to est déplacée vers pstn.dest.

logic.voice_goto

Démarre une autre entrée dans la même définition. La nouvelle visite reçoit des trigger.data nouvelles et efface les sorties et variables des étapes précédentes ; l'appel continue.

Automations

automation.send_event

Envoie un événement applicatif à une Automation sans attendre d'exécution. L'appel continue dès que l'événement est mis en file d'attente ; le démarrage éventuel d'une exécution n'est visible que dans Automations.

Fin de l'appel

logic.exit

Met fin à l'appel avec un résultat.

voice.hangup

Met fin à l'appel sans résultat défini. Ce nœud n'a ni champs ni résultats.

Consultez Utiliser les données d'application dans une séquence vocale pour voice.webhook.

Exemple : transfert vers une personne

Cette définition salue le destinataire, compose un numéro de support et enregistre si le transfert a abouti :

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

Envoyez-la en tant que sequence.definition avec "entry_node_id": "start" et "trigger_data": {}.