Passer au contenu

API et webhooks

API numéroteur et webhooks : prêts pour la production, pas une diapositive de roadmap.

Plus de 25 endpoints REST, des webhooks en temps réel, une authentification JWT et une documentation interactive. Chaque fonctionnalité de l'interface est disponible via l'API.

Essai gratuit de 14 jours · crédit IA gratuit pour essayer l'agent vocal IA · sans carte bancaire

Développé par BroadNet — 22 ans dans les télécoms 11 langues, adaptées aux dialectes BYOC — vos opérateurs, sans verrouillage Soutien à la conformité (TCPA, RGPD, TDRA)

Réponse rapide

Qu'est-ce que l'API DialerBee ? DialerBee fournit une API REST prête pour la production, avec plus de 25 endpoints couvrant les campagnes, les contacts, les appels, les agents, la conformité, les enregistrements, les rapports et les webhooks. L'authentification repose sur des jetons JWT de type bearer valables 24 heures. L'API prend en charge la pagination par curseur, renvoie des erreurs au format RFC 7807 et applique une limite de 2 000 requêtes/minute par tenant. Les webhooks en temps réel transmettent des événements (call.started, call.answered, call.amd_result, disposition.set, compliance.blocked, etc.) avec vérification de signature HMAC-SHA256 et nouvelles tentatives à délai exponentiel. La documentation interactive de l'API est disponible sur app.dialerbee.com/admin/api-docs.html.

Le problème

La plupart des API de numéroteurs sont pensées après coup

Vous avez acheté un numéroteur pour passer des appels. Il faut maintenant l'intégrer à votre CRM, envoyer les données vers votre entrepôt de données, déclencher des workflows à partir des événements d'appel et créer des tableaux de bord sur mesure. Vous consultez la documentation API de l'éditeur et vous trouvez… un PDF de 2019 avec 6 endpoints non documentés, aucun webhook et une interface SOAP.

C'est la réalité de la plupart des équipes d'appels sortants. Le numéroteur fonctionne bien pour passer des appels, mais dès que vous devez bâtir dessus — synchroniser les qualifications avec Salesforce, créer automatiquement des tickets dans Zendesk, envoyer l'analytique vers votre outil de BI ou créer une interface agent sur mesure — vous êtes coincé avec des exports CSV et des processus manuels.

DialerBee a été conçu API-first. Chaque fonctionnalité de l'interface s'appuie sur la même API REST que vous pouvez appeler depuis vos propres systèmes. L'API n'est pas un module greffé : c'est le socle sur lequel repose toute la plateforme.

6
Endpoints habituels des éditeurs
non documentés, pas de webhooks
SOAP
Protocole hérité
de nombreux numéroteurs utilisent encore XML/SOAP
CSV
Intégration par export uniquement
transferts de fichiers manuels, pas de temps réel

Comment ça marche

API-first par conception

L'API DialerBee suit les conventions REST : charges utiles JSON, méthodes HTTP standard et erreurs au format RFC 7807. L'authentification utilise des jetons JWT de type bearer obtenus via un endpoint de connexion, valables 24 heures, avec renouvellement des jetons. Chaque réponse de l'API inclut des en-têtes de limitation de débit, pour que votre intégration puisse réguler elle-même son rythme en douceur.

Étape 01

S'authentifier

Envoyez une requête POST à /v1/login avec vos identifiants. Vous recevez un jeton JWT de type bearer valable 24 heures. Utilisez le renouvellement du jeton pour les intégrations de longue durée.

Étape 02

Appeler les endpoints

Plus de 25 endpoints RESTful pour les campagnes, les contacts, les appels, les agents, la conformité, les enregistrements et les rapports. JSON en entrée, JSON en sortie.

Étape 03

Recevoir les webhooks

Enregistrez des URL de webhook pour recevoir des événements en temps réel. Chaque charge utile est signée en HMAC-SHA256 pour que vous puissiez en vérifier l'authenticité.

Étape 04

Gérer les erreurs

Erreurs au format RFC 7807 Problem Details. En-têtes de limitation de débit dans chaque réponse. Statut 429 avec indication Retry-After.

Comparatif

API DialerBee vs les API de numéroteurs classiques

Fonctionnalité API de numéroteur classique API DialerBee
Endpoints 5 à 10, partiellement documentés Plus de 25, entièrement documentés avec spécification OpenAPI
Protocole SOAP/XML ou propriétaire REST avec JSON, erreurs RFC 7807
Authentification Clé API (n'expire jamais) JWT valable 24 h + renouvellement du jeton
Événements en temps réel Polling ou rien Webhooks signés HMAC-SHA256 avec nouvelles tentatives
Pagination Par offset ou aucune Par curseur, avec next_cursor + has_more
Limitation de débit Non documentée 2 000 requêtes/min avec en-têtes dans chaque réponse
Documentation PDF ou wiki obsolète Documentation Swagger interactive en ligne
Multi-tenant Mono-tenant uniquement Périmètre par tenant sur chaque endpoint

Référence des endpoints

10 groupes d'API. Plus de 25 endpoints.

Groupe d'API Endpoints
Authentification POST /login, POST /refresh
Campagnes CRUD + démarrage/pause
Contacts Importer, lister, rechercher
Appels Historique, compteurs en direct, émission
Agents État, enregistrement SIP
Conformité et DNC Vérifications préalables à la numérotation, listes DNC
Enregistrements Liste, URL de lecture signées
Rapports Exporter (CSV, JSON, PDF)
Webhooks S'abonner, gérer, vérifier
Système État de santé, version

Démarrage rapide

Authentifiez-vous et lancez la numérotation en 3 appels API

Étape 1 S'authentifier
POST /v1/login
Content-Type: application/json

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

→ Response: { "token": "eyJhbG...", "expires_in": 86400 }
Étape 2 Créez une campagne
POST /v1/campaigns
Authorization: Bearer eyJhbG...

{
  "name": "Q3 Collections",
  "mode": "progressive",
  "amd_enabled": true,
  "compliance_profile": "uae-tdra"
}
Étape 3 Importez vos contacts et lancez la campagne
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

Événements en temps réel transmis à vos systèmes

Les webhooks transmettent les événements à vos systèmes en temps réel, sans polling. Chaque charge utile de webhook est signée avec HMAC-SHA256 pour que vous puissiez vérifier qu'elle provient bien de DialerBee et n'a pas été altérée. Si votre endpoint est indisponible, les webhooks sont renvoyés avec un délai exponentiel pendant 2 heures 35 minutes au maximum, pour que vous ne manquiez jamais un événement.

call.started

Un nouvel appel sortant a été lancé

call.answered

Le destinataire a décroché — classification AMD incluse

call.ended

Appel terminé, avec durée, qualification et URL de l'enregistrement

call.amd_result

Résultat de la classification AMD : humain ou machine, avec score de confiance

agent.state_change

L'agent est passé en disponible, en communication, en post-appel ou hors ligne

disposition.set

L'agent a saisi une qualification avec le résultat et des notes

compliance.blocked

Un appel a été bloqué par le moteur de conformité, avec le détail de la règle

campaign.started

La campagne a commencé à composer les numéros

campaign.paused

Campagne mise en pause par le superviseur ou le système

recording.ready

L'enregistrement de l'appel est traité et prêt à être écouté

contact.dnc_added

Un contact a été ajouté à la liste d'exclusion DNC

callback.scheduled

L'agent a programmé un rappel pour un contact

Sous le capot

Conçu pour les développeurs qui livrent

Protocole HTTPS uniquement (TLS 1.2+)
Format Corps de requête et de réponse JSON
Authentification Jetons JWT de type bearer (valables 24 heures) avec renouvellement
Versionnage Chemin d'URL /v1 + schema_version dans les webhooks
Pagination Par curseur, avec next_cursor et has_more
Limitation de débit 2 000 requêtes/minute par tenant, avec en-têtes
Format d'erreur RFC 7807 Problem Details pour les API HTTP
Signature des webhooks Vérification de signature HMAC-SHA256
Nouvelles tentatives des webhooks Délai exponentiel (2 h 35 min au total maximum)
URL des enregistrements URL signées valables 1 heure via MinIO
Registres DNC Émirats arabes unis (TDRA), Arabie saoudite (CST), Égypte (NTRA), Jordanie (TRC)
SDK JavaScript et Python (bientôt disponibles)

Questions fréquentes sur l'API

L'API est-elle disponible avec toutes les offres ?
L'accès à l'API REST est disponible avec toutes les offres. Les offres Starter ont un périmètre API limité (lecture seule pour certains endpoints). Les offres Professional et Enterprise incluent un accès API complet avec opérations d'écriture, webhooks et limites de débit plus élevées.
Où puis-je trouver la documentation de l'API ?
La documentation interactive de l'API est disponible sur app.dialerbee.com/admin/api-docs.html. Elle comprend la description des endpoints, des exemples de requêtes/réponses, des guides d'authentification et un explorateur d'API en direct pour tester les appels directement.
Comment fonctionne l'authentification des webhooks ?
Chaque charge utile de webhook inclut une signature HMAC-SHA256 dans l'en-tête X-Signature. Votre endpoint doit calculer le HMAC du corps brut de la requête à l'aide de votre secret de webhook et le comparer à la signature. Cela permet de vérifier que la charge utile provient bien de DialerBee et n'a pas été modifiée lors de sa transmission.
Que se passe-t-il si mon endpoint de webhook est indisponible ?
DialerBee renvoie les webhooks dont la livraison a échoué avec un délai exponentiel. Les nouvelles tentatives se poursuivent pendant 2 heures et 35 minutes au total au maximum. Une fois toutes les tentatives épuisées, l'événement est journalisé comme non livré et visible dans votre tableau de bord des webhooks.
Puis-je utiliser l'API pour créer une interface d'agent personnalisée ?
Oui. L'API expose tous les endpoints liés aux agents : gestion d'état, contrôle d'appel, saisie de la qualification, recherche de contacts et lecture des enregistrements. Combinée aux événements WebSocket pour les mises à jour en temps réel, elle vous permet de créer une expérience agent entièrement sur mesure.
L'API est-elle multi-tenant ?
Oui. Chaque appel d'API est limité au tenant authentifié. Les comptes partenaires/revendeurs peuvent gérer plusieurs tenants via l'API Partenaire, y compris le provisionnement, la configuration et la gestion de la facturation des tenants.
Quelle est la limite de débit ?
2 000 requêtes par minute par tenant. Chaque réponse contient les en-têtes X-RateLimit-Limit, X-RateLimit-Remaining et X-RateLimit-Reset. Si vous dépassez la limite, vous recevez un statut 429 avec un en-tête Retry-After.
Des SDK sont-ils disponibles ?
Des SDK JavaScript et Python sont en cours de développement. En attendant, l'API suit les conventions REST standard avec des charges utiles JSON : n'importe quel client HTTP, dans n'importe quel langage, fonctionne. La documentation interactive inclut des exemples curl pour chaque endpoint.

Sachez à quoi vous pouvez vous abonner

Chaque événement est documenté avant que vous ne construisiez

La plateforme publie un événement pour tout ce qui compte lors d'un appel, et chacun est catalogué avec la structure de sa charge utile — vous savez donc ce que contiendra un webhook avant même d'écrire le gestionnaire, au lieu de découvrir le schéma à partir de ce qui arrive en premier.

Le cycle de vie des appels, l'état des campagnes, l'activité des agents, la qualification, la disponibilité des enregistrements, les décisions de conformité et la livraison des messages publient chacun leurs propres événements. Abonnez-vous à ceux qui intéressent votre intégration et ignorez les autres : vous n'êtes pas obligé d'absorber un flux complet pour obtenir les trois événements dont vous avez besoin.

Prêt à intégrer ?

Explorez la documentation API en ligne ou réservez une démo pour obtenir un accès API. Créez votre première intégration en quelques heures, pas en quelques semaines.

Essai gratuit de 14 jours · crédit IA gratuit · sans carte · voir les tarifs

Voir le site complet en anglais →