Saltar al contenido principal
La API de LobbyStack permite que sus propias herramientas trabajen con los datos del agente de un negocio. Zapier, un servidor MCP o un script pueden leer llamadas y mensajes, mantener los contactos sincronizados, reservar citas, agregar conocimiento y suscribirse a webhooks. La API llama a su agente receptionist y a su espacio de trabajo business, como en GET /receptionist. GET /agents enumera los agentes del espacio de trabajo. /receptionist y /rules actúan sobre el agente predeterminado, y cada llamada y mensaje indica en agent_id el agente que lo atendió. El channel de una regla la limita a voice, sms, web_chat o instagram, y null la aplica en todos los canales. voice_instructions, sms_instructions y chat_instructions en /receptionist y /agents están obsoletos. Leen la primera regla activa del agente para ese canal, y escribir uno cambia esa regla o la añade. chat_instructions escribe las reglas del chat del sitio web y de Instagram. Enviar null elimina la regla del canal.

Agréguela a su producto. Integre una recepcionista con IA en su SaaS mediante la API. Sus clientes se quedan en su interfaz.

URL base

En una implementación autoalojada, use su APP_BASE_URL seguido de /api/v1.

Haga su primera solicitud

1

Cree una clave de API

En el panel, vaya a Configuración > Claves de API y haga clic en Crear clave de API. Elija el acceso que necesita la clave. Consulte Autenticación.
2

Llame a la API

La respuesta envuelve el recurso en data:

Convenciones

  • Las solicitudes y las respuestas usan JSON. Los nombres de los campos usan snake_case.
  • Los ID son UUID y nunca cambian.
  • Las marcas de tiempo usan ISO 8601 en UTC, por ejemplo 2026-09-29T13:30:00.000Z. Los cuerpos de las solicitudes también aceptan un desfase numérico como -04:00.
  • Las listas devuelven data, next_cursor y has_more. Consulte Solicitudes y errores.
  • Una clave de API del panel pertenece a un negocio, así que no necesita enviar un ID de negocio. Una clave de plataforma indica el negocio en el encabezado LobbyStack-Business.

OpenAPI

La API publica un documento OpenAPI 3.1 en GET /api/v1/openapi.json, sin necesidad de clave. LobbyStack lo genera a partir de los mismos esquemas con los que valida el servidor, así que siempre coincide con la versión en ejecución. Impórtelo en Postman, genere un cliente o consulte la sección Referencia de la API de esta documentación, que LobbyStack crea a partir del mismo archivo.

Versiones

La versión forma parte de la ruta: /api/v1. Dentro de v1, LobbyStack solo hace cambios aditivos:
  • Nuevos endpoints, nuevos campos opcionales en las solicitudes y nuevos campos en las respuestas.
  • Nuevos valores en listas como los tipos de eventos de webhook y los códigos de error.
Cree clientes que ignoren los campos y los tipos de eventos que no reconozcan. LobbyStack publica los cambios incompatibles solo como una nueva versión, como /api/v2. Eliminar o cambiar el nombre de un campo, cambiar un tipo o agregar un campo obligatorio en las solicitudes se considera un cambio incompatible. Cuando sale una nueva versión, v1 sigue funcionando junto a ella. Las cargas útiles de los webhooks incluyen api_version para que sepa qué formato recibió.