API y Webhooks

API lista para producción. No es una diapositiva de hoja de ruta.

Más de 25 puntos finales REST, webhooks en tiempo real, autenticación JWT y documentación interactiva. Todas las funciones que utilizas en la interfaz de usuario están disponibles a través de la API.

Respuesta rápida

¿Qué es la API de DialerBee? DialerBee proporciona una API REST lista para producción con más de 25 endpoints que abarcan campañas, contactos, llamadas, agentes, cumplimiento normativo, grabaciones, informes y webhooks. La autenticación utiliza tokens JWT con caducidad de 24 horas. La API admite paginación basada en cursor, devuelve respuestas de error RFC 7807 y aplica un límite de 2000 solicitudes por minuto por inquilino. Los webhooks en tiempo real entregan eventos (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked, etc.) con verificación de firma HMAC-SHA256 y retroceso exponencial de reintentos. La documentación interactiva de la API está disponible en dialer.broadnet.me/admin/api-docs.html.

El problema

La mayoría de las API de marcación son una idea de último momento

Compraste un marcador telefónico para realizar llamadas. Ahora necesitas integrarlo con tu CRM, enviar datos a tu almacén de datos, activar flujos de trabajo a partir de eventos de llamadas y crear paneles personalizados. Consultas la documentación de la API del proveedor y te encuentras con... un PDF de 2019 con 6 puntos finales sin documentar, sin webhooks y con una interfaz SOAP.

Esta es la realidad para la mayoría de los equipos de llamadas salientes. El marcador funciona bien para hacer llamadas, pero en el momento en que necesitas... construir sobre él — sincronizar las disposiciones con Salesforce, crear automáticamente tickets en Zendesk, enviar análisis a su herramienta de BI o crear una interfaz de agente personalizada: está atascado con exportaciones CSV y procesos manuales.

DialerBee se diseñó priorizando la API. Cada función de la interfaz de usuario se basa en la misma API REST a la que puedes acceder desde tus propios sistemas. La API no es un complemento, sino la base sobre la que se sustenta toda la plataforma.

6
Puntos finales típicos del proveedor
No documentado, sin webhooks
JABÓN
Protocolo heredado
Muchos sistemas de marcación automática todavía utilizan XML/SOAP.
CSV
Integración solo para exportación
transferencias manuales de archivos, sin tiempo real

Cómo funciona

API-first a propósito

La API de DialerBee sigue las convenciones REST con cargas útiles JSON, métodos HTTP estándar y respuestas de error RFC 7807. La autenticación utiliza tokens JWT de portador obtenidos a través de un punto final de inicio de sesión, con caducidad de 24 horas y soporte para actualización de tokens. Cada respuesta de la API incluye encabezados de límite de velocidad para que su integración pueda regular la velocidad de forma controlada.

Paso 01

Autenticar

Envía una solicitud POST a /v1/login con tus credenciales. Recibirás un token JWT válido por 24 horas. Para integraciones de larga duración, utiliza la función de actualización de token.

Paso 02

Puntos finales de llamada

Más de 25 puntos finales RESTful para campañas, contactos, llamadas, agentes, cumplimiento normativo, grabaciones e informes. Entrada y salida en formato JSON.

Paso 03

Recibir webhooks

Registre las URL de webhook para recibir eventos en tiempo real. Cada carga útil está firmada con HMAC-SHA256 para que pueda verificar su autenticidad.

Paso 04

Manejar errores

RFC 7807 Detalles del problema para cada error. Encabezados de límite de velocidad en cada respuesta. Estado 429 con instrucciones para reintentar después.

Comparación lado a lado

API de DialerBee vs API de marcación típicas

Capacidad API de marcador típico API de DialerBee
Puntos finales 5-10, parcialmente documentado Más de 25 proyectos totalmente documentados con la especificación OpenAPI.
Protocolo SOAP/XML o propietario REST con JSON, errores RFC 7807
Autenticación Clave API (sin caducidad) JWT con caducidad de 24 horas + actualización del token
Eventos en tiempo real ¿Encuesta o ninguna? Webhooks firmados con HMAC-SHA256 con reintento
Paginación Basado en desplazamiento o ninguno Basado en cursor con next_cursor + has_more
limitación de velocidad Indocumentados 2000 solicitudes/min con encabezados en cada respuesta
Documentación PDF o wiki desactualizada Documentación interactiva en vivo de Swagger
Multiusuario Solo para un inquilino Definición del alcance por inquilino en cada punto final.

Referencia del punto final

10 grupos de API. Más de 25 puntos finales.

Grupo API Puntos finales
Autenticación POST /login, POST /refresh
Campañas CRUD + inicio/pausa
Contactos Subir, listar, buscar
Llamadas Historia, recuentos en vivo, origen
Agentes Estado, registro SIP
Cumplimiento y DNC Verificaciones previas a la llamada, listas de no llamar
Grabaciones Lista de URL de reproducción firmadas
Informes Exportar (CSV, JSON, PDF)
Webhooks Suscríbete, gestiona, verifica
Sistema Salud, versión

Inicio rápido

Autentícate y comienza a marcar. en 3 llamadas a la API

Paso 1 Autenticar
CORREO /v1/login
Tipo de contenido: aplicación/json

{
  "correo electrónico": "admin@yourcompany.com",
  "contraseña": "••••••••"
}

→ Respuesta: { "simbólico": "eyJhbG...", "expira_en": 86400 }
Paso 2 Crea una campaña
CORREO /v1/campañas
Autorización: Portador eyJhbG...

{
  "nombre": "Colecciones del tercer trimestre",
  "modo": "progresivo",
  "amd_enabled": true,
  "perfil_de_cumplimiento": "EAU-TDRA"
}
Paso 3 Sube tus contactos y comienza
CORREO /v1/campañas/{id}/contactos
Tipo de contenido: multipart/form-data

→ Cargar CSV con teléfono, nombre y campos personalizados

CORREO /v1/campañas/{id}/inicio
→ La campaña está llamando ahora

Webhooks

Eventos en tiempo real entregado a sus sistemas

Los webhooks envían eventos a sus sistemas en tiempo real, sin necesidad de sondeo. Cada carga útil del webhook está firmada con HMAC-SHA256 Así podrás verificar que proviene de DialerBee y que no ha sido manipulado. Si tu punto final no está disponible, los webhooks se reintentan con un retroceso exponencial durante un máximo de 2 horas y 35 minutos, lo que garantiza que nunca te pierdas un evento.

llamada iniciada

Se ha iniciado una nueva llamada saliente.

llamada contestada

El destinatario recogió: la clasificación AMD incluía

llamada finalizada

Llamada completada con duración, resultado y URL de grabación.

llamada.amd_result

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

cambio_de_estado del agente

El agente pasó a estar disponible, de guardia, finalizando su turno o desconectado.

disposición.set

El agente presentó una resolución con el resultado y las notas.

cumplimiento.bloqueado

Una llamada fue bloqueada por el motor de cumplimiento con detalles de la regla

campaña.iniciado

La campaña comenzó a marcar

campaña.pausada

Campaña pausada por el supervisor o el sistema.

grabación.lista

La grabación de la llamada se ha procesado y está lista para su reproducción.

contacto.dnc_añadido

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

devolución de llamada programada

El agente programó una llamada de seguimiento para un contacto.

Bajo el capó

Diseñado para desarrolladores que lanzan productos

Protocolo Solo HTTPS (TLS 1.2+)
Formato Cuerpos de solicitud y respuesta JSON
Autenticación Tokens JWT Bearer (caducidad de 24 horas) con actualización
Control de versiones Ruta URL /v1 + schema_version en webhooks
Paginación Basado en cursor con next_cursor y has_more
limitación de velocidad 2000 solicitudes/minuto por inquilino con encabezados
Formato de error RFC 7807 Detalles del problema para las API HTTP
Firma de webhook Verificación de firma HMAC-SHA256
Reintentos de webhook Retroceso exponencial (máximo 2 h 35 min en total)
URLs de grabación URLs firmadas con caducidad de 1 hora a través de MinIO
registros del DNC EAU (TDRA), KSA (CITC), 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 Básicos tienen un alcance de API limitado (solo lectura para algunos puntos finales). Los planes Profesional y Empresarial incluyen acceso completo a la API con operaciones de escritura, webhooks y límites de velocidad más altos.
¿Dónde puedo encontrar la documentación de la API?
La documentación interactiva de la API está disponible en dialer.broadnet.me/admin/api-docs.html. Incluye descripciones de los puntos finales, ejemplos de solicitudes y respuestas, guías de autenticación y un explorador de API en tiempo real donde puede probar las llamadas directamente.
¿Cómo funciona la autenticación mediante webhook?
Cada carga útil de webhook incluye una firma HMAC-SHA256 en el encabezado X-Signature. Tu endpoint debe calcular el HMAC del cuerpo de la solicitud sin procesar utilizando tu secreto de webhook y compararlo con la firma. Esto verifica que la carga útil proviene de DialerBee y no fue modificada durante la transmisión.
¿Qué sucede si mi punto final de webhook no está disponible?
DialerBee reintenta las entregas de webhooks fallidas con un retroceso exponencial. Los reintentos continúan durante un máximo de 2 horas y 35 minutos. Una vez agotados todos los reintentos, el evento se registra como no entregado y se muestra en el panel de control de webhooks.
¿Puedo usar la API para crear una interfaz de agente personalizada?
Sí. La API expone todos los puntos finales relacionados con el agente: gestión de estado, control de llamadas, envío de resoluciones, búsqueda de contactos y reproducción de grabaciones. Combinada con eventos WebSocket para actualizaciones en tiempo real, permite crear una experiencia de agente totalmente personalizada.
¿La API es multiusuario?
Sí. Cada llamada a la API está limitada al inquilino autenticado. Las cuentas de socios/revendedores pueden gestionar varios inquilinos a través de la API para socios, incluyendo el aprovisionamiento, la configuración y la gestión de la facturación.
¿Cuál es el límite de velocidad?
2000 solicitudes por minuto por inquilino. 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 el encabezado Retry-After.
¿Hay SDK disponibles?
Los SDK de JavaScript y Python están en desarrollo. Mientras tanto, la API utiliza las convenciones REST estándar con cargas útiles JSON, por lo que funciona con cualquier cliente HTTP en cualquier lenguaje. La documentación interactiva incluye ejemplos de curl para cada endpoint.

¿Listo para integrar?

Consulta la documentación de la API en tiempo real o reserva una demostración para obtener acceso. Crea tu primera integración en horas, no en semanas.

View full site in English →