Skip to main content

​
Le vocabulaire minimal

Ces termes sont utilisés dans toute la documentation. Une bonne compréhension de ceux-ci évite la plupart des erreurs d’intégration.
Un agent vocal est un graphe appelé workflow_definition : une liste de nœuds reliés par des arêtes. Il est stocké côté Bookivox et identifiable par un UUID public. C’est ce graphe que le moteur exécute pendant un appel. Voir Workflow (JSON).
Une étape du graphe. Chaque nœud a un type et un data dont le schéma dépend du type. Les types disponibles :Le schéma exact des champs de data est fourni par le catalogue GET /api/v1/api/node-types. Voir Nœuds (graphe).
Une transition entre deux nœuds. Elle porte un data.label (libellé) et un data.condition (condition de passage). Voir Workflow (JSON).
Une capacité attachée à un nœud agentNode et invoquée pendant l’appel. Exemples : appeler votre API (http_api), raccrocher (end_call), transférer l’appel (transfer_call). Voir Outils (API).
Un secret (clé API tierce, jeton OAuth) géré côté Bookivox et référencé par un credential_uuid. Il n’apparaît jamais en clair dans vos définitions. Voir Intégrations HTTP (API).
La façon dont Bookivox référence les ressources (workflow, tool, document, configuration téléphonie) : une chaîne UUID opaque, jamais un identifiant interne séquentiel. Utilisez toujours la valeur renvoyée par l’API.
Une exécution d’un agent (un appel). Les runs portent le transcript, le résultat d’extraction et les événements. Les campagnes produisent des runs en masse.
L’exécution d’un agent sur un ensemble de contacts (source CSV), avec politique de réessai et de planification. Voir Campagnes.

​
Le modèle d’authentification

Une seule méthode pour l’API publique : l’en-tête X-API-Key.

​
Suite

Workflow (JSON)

Le format du graphe en détail.

Nœuds (graphe)

Schémas NodeSpec / PropertySpec.

Outils (API)

Types d’outils et CRUD.

Erreurs & codes

Interpréter les réponses.
Last modified on October 28, 2026