Saltar al contenido

API y webhooks

API y webhooks del marcador: listos para producción, no una diapositiva de hoja de ruta.

Más de 25 endpoints REST, webhooks en tiempo real, autenticación JWT y documentación interactiva. Cada función que usa en la interfaz está disponible por API.

Prueba gratuita de 14 días · crédito de IA gratuito para probar el agente de voz con IA · sin tarjeta

Creado por BroadNet, 22 años en telecomunicaciones 11 idiomas, adaptado a dialectos BYOC: sus operadores, sin ataduras Controles que apoyan el cumplimiento (TCPA, RGPD, TDRA)

Respuesta rápida

¿Qué es la API de DialerBee? DialerBee ofrece una API REST lista para producción con más de 25 endpoints que cubren campañas, contactos, llamadas, agentes, cumplimiento, grabaciones, reportes y webhooks. La autenticación usa tokens bearer JWT con vencimiento de 24 horas. La API admite paginación basada en cursor, devuelve respuestas de error RFC 7807 y aplica un límite de 2,000 solicitudes por minuto por tenant. Los webhooks en tiempo real envían eventos (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked, etc.) con verificación de firma HMAC-SHA256 y reintentos con retroceso exponencial. La documentación interactiva de la API está disponible en app.dialerbee.com/admin/api-docs.html.

El problema

La mayoría de las API de dialers son algo secundario

Compró un dialer para hacer llamadas. Ahora necesita integrarlo con su CRM, enviar datos a su data warehouse, activar flujos de trabajo a partir de eventos de llamada y crear paneles a medida. Revisa la documentación de la API del proveedor y encuentra... un PDF de 2019 con 6 endpoints sin documentar, sin webhooks y con una interfaz SOAP.

Esa es la realidad de la mayoría de los equipos de llamadas salientes. El dialer funciona bien para llamar, pero en cuanto necesita construir sobre él —sincronizar tipificaciones con Salesforce, crear tickets automáticamente en Zendesk, enviar analítica a su herramienta de BI o crear una interfaz de agente a medida—, queda atrapado con exportaciones CSV y procesos manuales.

DialerBee se creó con un enfoque API-first. Cada función de la interfaz se apoya en la misma API REST que usted puede llamar desde sus propios sistemas. La API no es un añadido: es la base sobre la que funciona toda la plataforma.

6
Endpoints típicos de un proveedor
sin documentar, sin webhooks
SOAP
Protocolo heredado
muchos dialers todavía usan XML/SOAP
CSV
Integración solo por exportación
transferencias manuales de archivos, nada en tiempo real

Cómo funciona

API-first por diseño

La API de DialerBee sigue las convenciones REST con cargas JSON, métodos HTTP estándar y respuestas de error RFC 7807. La autenticación usa tokens bearer JWT obtenidos mediante un endpoint de inicio de sesión, con vencimiento de 24 horas y soporte para renovación del token. Cada respuesta de la API incluye encabezados de límite de solicitudes para que su integración pueda autorregularse sin problemas.

Paso 01

Autenticarse

Haga un POST a /v1/login con sus credenciales. Reciba un token bearer JWT válido por 24 horas. Use la renovación del token para integraciones de larga duración.

Paso 02

Llamar a los endpoints

Más de 25 endpoints RESTful para campañas, contactos, llamadas, agentes, cumplimiento, grabaciones y reportes. Entra JSON, sale JSON.

Paso 03

Recibir webhooks

Registre URL de webhook para recibir eventos en tiempo real. Cada carga va firmada con HMAC-SHA256 para que pueda verificar su autenticidad.

Paso 04

Gestionar errores

RFC 7807 Problem Details para cada error. Encabezados de límite de solicitudes en cada respuesta. Estado 429 con indicación de retry-after.

Comparación lado a lado

API de DialerBee frente a las API típicas de dialers

Capacidad API típica de dialer API de DialerBee
Endpoints 5 a 10, parcialmente documentados Más de 25, totalmente documentados con especificación OpenAPI
Protocolo SOAP/XML o propietario REST con JSON, errores RFC 7807
Authentication Clave de API (nunca vence) JWT con vencimiento de 24 h + renovación del token
Eventos en tiempo real Consulta periódica (polling) o nada Webhooks firmados con HMAC-SHA256 y reintentos
Paginación Basada en offset o inexistente Basada en cursor con next_cursor + has_more
Límite de solicitudes Sin documentar 2,000 solicitudes/min con encabezados en cada respuesta
Documentación PDF o wiki desactualizada Documentación Swagger interactiva y en vivo
Multi-tenant Solo un tenant Delimitación por tenant en cada endpoint

Referencia de endpoints

10 grupos de API. Más de 25 endpoints.

Grupo de API Endpoints
Authentication POST /login, POST /refresh
Campañas CRUD + iniciar/pausar
Contactos Cargar, listar, buscar
Llamadas Historial, conteos en vivo, originar
Agentes Estado, registro SIP
Cumplimiento y DNC Verificaciones previas a la marcación, listas DNC
Grabaciones Listado, URL de reproducción firmadas
Informes Exportar (CSV, JSON, PDF)
Webhooks Suscribir, gestionar, verificar
Sistema Estado, versión

Inicio rápido

Autentíquese y empiece a marcar en 3 llamadas a la API

Paso 1 Autenticarse
POST /v1/login
Content-Type: application/json

{
  "email": "admin@yourcompany.com",
  "password": "••••••••"
}

→ Response: { "token": "eyJhbG...", "expires_in": 86400 }
Paso 2 Crear una campaña
POST /v1/campaigns
Authorization: Bearer eyJhbG...

{
  "name": "Q3 Collections",
  "mode": "progressive",
  "amd_enabled": true,
  "compliance_profile": "uae-tdra"
}
Paso 3 Cargar contactos e iniciar
POST /v1/campaigns/{id}/contacts
Content-Type: multipart/form-data

→ Upload CSV with phone, name, and custom fields

POST /v1/campaigns/{id}/start
→ Campaign is now dialing

Webhooks

Eventos en tiempo real enviados a sus sistemas

Los webhooks envían eventos a sus sistemas en tiempo real, sin necesidad de consultas periódicas. Cada carga de webhook va firmada con HMAC-SHA256 para que pueda verificar que proviene de DialerBee y que no fue alterada. Si su endpoint está caído, los webhooks se reintentan con retroceso exponencial durante un máximo de 2 horas y 35 minutos, para que nunca pierda un evento.

call.started

Se inició una nueva llamada saliente

call.answered

El destinatario contestó; incluye la clasificación del AMD

call.ended

Llamada finalizada con duración, tipificación y URL de la grabación

call.amd_result

Resultado de la clasificación del AMD: persona o máquina, con puntuación de confianza

agent.state_change

El agente pasó a disponible, en llamada, post-llamada o desconectado

disposition.set

El agente registró una tipificación con resultado y notas

compliance.blocked

El motor de cumplimiento bloqueó una llamada, con el detalle de la regla

campaign.started

La campaña empezó a marcar

campaign.paused

Campaña pausada por un supervisor o por el sistema

recording.ready

La grabación de la llamada está procesada y lista para reproducirse

contact.dnc_added

Se agregó un contacto a la lista de supresión DNC

callback.scheduled

El agente programó una devolución de llamada para un contacto

Bajo el capó

Hecho para desarrolladores que entregan

Protocolo Solo HTTPS (TLS 1.2+)
Formato Cuerpos de solicitud y respuesta en JSON
Authentication Tokens bearer JWT (vencimiento de 24 horas) con renovación
Versionado Ruta URL /v1 + schema_version en los webhooks
Paginación Basada en cursor con next_cursor y has_more
Límite de solicitudes 2,000 solicitudes/minuto por tenant, con encabezados
Formato de error RFC 7807 Problem Details for HTTP APIs
Firma de webhooks Verificación de firma HMAC-SHA256
Reintentos de webhooks Retroceso exponencial (máximo 2 h 35 min en total)
URL de grabaciones URL firmadas con vencimiento de 1 hora mediante MinIO
Registros DNC EAU (TDRA), KSA (CST), Egipto (NTRA), Jordania (TRC)
SDK JavaScript y Python (próximamente)

Preguntas frecuentes sobre la API

¿La API está disponible en todos los planes?
El acceso a la API REST está disponible en todos los planes. Los planes Starter tienen un alcance de API limitado (solo lectura en algunos endpoints). Los planes Professional y Enterprise incluyen acceso completo a la API con operaciones de escritura, webhooks y límites de solicitudes más altos.
¿Dónde encuentro la documentación de la API?
La documentación interactiva de la API está disponible en app.dialerbee.com/admin/api-docs.html. Incluye descripciones de endpoints, ejemplos de solicitudes y respuestas, guías de autenticación y un explorador de API en vivo donde puede probar llamadas directamente.
¿Cómo funciona la autenticación de webhooks?
Cada carga de webhook incluye una firma HMAC-SHA256 en el encabezado X-Signature. Su endpoint debe calcular el HMAC del cuerpo bruto de la solicitud con su secreto de webhook y compararlo con la firma. Así se verifica que la carga proviene de DialerBee y que no se modificó en tránsito.
¿Qué pasa si mi endpoint de webhook está caído?
DialerBee reintenta los envíos de webhook fallidos con retroceso exponencial. Los reintentos continúan durante un máximo de 2 horas y 35 minutos en total. Cuando se agotan todos los reintentos, el evento queda registrado como no entregado y visible en su panel de webhooks.
¿Puedo usar la API para crear una interfaz de agente a medida?
Sí. La API expone todos los endpoints relacionados con agentes: gestión de estados, control de llamadas, registro de tipificaciones, búsqueda de contactos y reproducción de grabaciones. Combinada con eventos WebSocket para actualizaciones en tiempo real, le permite crear una experiencia de agente totalmente personalizada.
¿La API es multi-tenant?
Sí. Cada llamada a la API se limita al tenant autenticado. Las cuentas de partners y revendedores pueden gestionar varios tenants mediante la API para partners, incluidos el aprovisionamiento de tenants, la configuración y la gestión de la facturación.
¿Cuál es el límite de solicitudes?
2,000 solicitudes por minuto por tenant. Cada respuesta incluye los encabezados X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset. Si supera el límite, recibirá un estado 429 con un encabezado Retry-After.
¿Hay SDK disponibles?
Los SDK de JavaScript y Python están en desarrollo. Mientras tanto, la API usa convenciones REST estándar con cargas JSON, así que funciona cualquier cliente HTTP en cualquier lenguaje. La documentación interactiva incluye ejemplos con curl para cada endpoint.

Sepa a qué puede suscribirse

Cada evento está documentado antes de que empiece a construir

La plataforma publica un evento para todo lo que importa en una llamada, y cada uno está catalogado con la estructura de su carga; así sabe qué contendrá un webhook antes de escribir el handler, en lugar de descubrir el esquema por lo primero que llegue.

El ciclo de vida de la llamada, el estado de la campaña, la actividad de los agentes, la tipificación, la disponibilidad de grabaciones, las decisiones de cumplimiento y la entrega de mensajes publican cada uno sus propios eventos. Suscríbase a los que le interesan a su integración e ignore el resto: no está obligado a consumir un flujo masivo para obtener los tres eventos que necesita.

¿Listo para integrar?

Explore la documentación de la API en vivo o agende una demo y obtenga acceso a la API. Cree su primera integración en horas, no en semanas.

Prueba gratuita de 14 días · crédito de IA gratuito · sin tarjeta · ver precios

Ver el sitio completo en inglés →