Passer au contenu principal
L’API LobbyStack permet à vos propres outils de travailler avec les données d’agent d’une entreprise. Zapier, un serveur MCP ou un script peuvent lire les appels et les messages, synchroniser les contacts, réserver des rendez-vous, ajouter des connaissances et s’abonner à des webhooks. L’API appelle votre agent receptionist et votre espace de travail business, comme dans GET /receptionist. GET /agents liste les agents de l’espace de travail. /receptionist et /rules agissent sur l’agent par défaut, et chaque appel et message indique dans agent_id l’agent qui l’a pris. Le channel d’une règle la limite à voice, sms, web_chat ou instagram, et null l’applique à tous les canaux. voice_instructions, sms_instructions et chat_instructions sur /receptionist et /agents sont dépréciés. Ils lisent la première règle active de l’agent pour ce canal, et en écrire un modifie cette règle ou l’ajoute. chat_instructions écrit les règles du clavardage du site web et d’Instagram. Envoyer null supprime la règle du canal.

Ajoutez-la à votre produit. Intégrez une réceptionniste IA à votre SaaS avec l'API. Vos clients restent dans votre interface.

URL de base

Sur un déploiement auto-hébergé, utilisez votre APP_BASE_URL suivie de /api/v1.

Faire votre première requête

1

Créer une clé API

Dans le tableau de bord, allez dans Réglages > Clés API et cliquez sur Créer une clé API. Choisissez l’accès dont la clé a besoin. Consultez Authentification.
2

Appeler l'API

La réponse place la ressource dans data :

Conventions

  • Les requêtes et les réponses utilisent JSON. Les noms de champs sont en snake_case.
  • Les identifiants sont des UUID et ne changent jamais.
  • Les horodatages suivent la norme ISO 8601 en UTC, par exemple 2026-09-29T13:30:00.000Z. Le corps des requêtes accepte aussi un décalage numérique comme -04:00.
  • Les listes renvoient data, next_cursor et has_more. Consultez Requêtes et erreurs.
  • Une clé API du tableau de bord appartient à une seule entreprise, donc vous ne transmettez pas d’identifiant d’entreprise. Une clé de plateforme nomme l’entreprise dans l’en-tête LobbyStack-Business.

OpenAPI

L’API publie un document OpenAPI 3.1 à GET /api/v1/openapi.json, sans clé requise. LobbyStack le génère à partir des mêmes schémas que ceux qu’utilise le serveur pour valider les requêtes. Il correspond donc toujours à la version en service. Importez-le dans Postman, générez un client ou parcourez la section Référence de l’API de cette documentation, que LobbyStack construit à partir du même fichier.

Gestion des versions

La version fait partie du chemin : /api/v1. Dans la v1, LobbyStack n’apporte que des ajouts :
  • De nouveaux points de terminaison, de nouveaux champs de requête facultatifs et de nouveaux champs de réponse.
  • De nouvelles valeurs dans des listes comme les types d’événements webhook et les codes d’erreur.
Concevez des clients qui ignorent les champs et les types d’événements qu’ils ne reconnaissent pas. LobbyStack publie les changements incompatibles uniquement dans une nouvelle version, comme /api/v2. Supprimer ou renommer un champ, changer un type ou ajouter un champ de requête obligatoire constitue un changement incompatible. Quand une nouvelle version sort, la v1 continue de fonctionner en parallèle. Les charges utiles des webhooks contiennent api_version pour que vous sachiez quelle forme vous avez reçue.