Guide — API REST

API messages vocaux pour intégrateurs télécom

Automatisez la commande et la récupération des fichiers audio depuis votre CRM, portail ou outil de provisioning.

L'API REST Studio Phone Express s'adresse aux intégrateurs et aux opérateurs qui industrialisent la voix sur un parc : création de commandes, suivi de statut, téléchargement des masters, webhooks optionnels. L'enjeu n'est pas de remplacer un formulaire par un appel HTTP, mais de supprimer les allers-retours qui ralentissent la mise en service : ressaisie du texte, relance par courriel, recherche du fichier dans une boîte de réception, dépôt manuel. En connectant votre CRM, votre outil de provisioning ou votre portail partenaire, la commande d'un message devient une étape de votre propre processus, et le livrable revient là où vos équipes en ont besoin. La supervision humaine, elle, reste dans la boucle qualité.

Cas d'usage d'intégration

Au-delà de quelques dizaines de sites, la commande manuelle devient le point de friction du déploiement. Provisioning d'un client PME : à la création du tenant IPBX, l'API commande un pack accueil et attente à partir des informations déjà saisies dans votre outil.

Portail revendeur ou extranet : un bouton « générer un message » appelle l'API depuis l'interface que vos clients utilisent déjà, dans votre marque. Côté ERP, le décompte des crédits et le rattachement des livrables se font au fil des commandes : le support retrouve en quelques secondes quelle version tourne sur quel site.

Le gain se mesure en délai de mise en service et en taux d'erreur : un parc automatisé produit ses messages au rythme du provisioning, sans ressaisie.

✓ Tenant IPBX créé : commande automatique du pack accueil et attente
✓ Portail partenaire : bouton de génération exposé à vos clients
✓ Provisioning : équipement d'un parc multi-sites piloté depuis votre automate
✓ ERP : décompte des crédits, rattachement des livrables

Flux type d'une commande automatisée

Authentification partenaire, création de la commande avec le texte, le type de message et la voix, suivi de production, notification, téléchargement aux formats demandés : le flux tient en cinq temps. La documentation s'appuie sur la spécification OpenAPI, standard ouvert porté par l'OpenAPI Initiative au sein de la Linux Foundation, ce qui permet de générer un client plutôt que d'écrire les appels à la main.

Deux modes de suivi coexistent. L'interrogation régulière du statut convient aux intégrations simples ; les webhooks notifient la fin de production et déclenchent aussitôt le téléchargement, puis le dépôt sur l'équipement. Le livrable restant attaché à la commande, un téléchargement se rejoue sans recréer de demande.

✓ POST de la commande avec les métadonnées client
✓ GET du statut et de la liste des livrables
✓ Téléchargement sécurisé des fichiers produits
✓ Notification de fin de production par webhook, selon configuration

Messages contextuels et messages d'alerte

Un accueil qui mentionne une fermeture exceptionnelle, une annonce de travaux sur un site précis, une information pendant une coupure : ces textes ont une durée de vie courte, mais personne ne les commande à la main pour trente sites.

Le déclencheur vient de votre supervision, d'un agenda partagé ou d'un ticket. Dès lors que le texte se construit à partir de données que vous détenez, la commande devient une action parmi d'autres dans votre automate. Nos messages sont livrés en moins de deux heures, ce qui rend l'annonce du jour même exploitable.

Commande automatisée, production supervisée

Automatiser la commande ne signifie pas automatiser la validation. Notre production s'appuie sur une intelligence artificielle supervisée : chaque message est retravaillé et validé à la main avant livraison. L'appel API remplace le formulaire, pas l'oreille humaine.

Conséquence pratique : le passage d'une commande à son livrable n'est pas instantané, et votre intégration doit être écrite en asynchrone plutôt que bloquer un écran sur une réponse immédiate. En contrepartie, vous n'héritez pas des défauts d'une synthèse brute, liaison fautive, nom propre écorché, intonation plate.

Sécurité, clés et environnements

Utilisez des clés distinctes par environnement, test et production, et stockez les secrets côté serveur. Une clé embarquée dans une application mobile ou dans un front web est une clé publiée : elle s'extrait du paquet ou se lit dans les requêtes du navigateur.

Le référentiel OWASP API Security Top 10, édition 2023, classe l'authentification défaillante au deuxième rang des risques et rappelle qu'une clé API identifie une application, non un utilisateur : le contrôle des droits de vos propres utilisateurs reste votre responsabilité, côté serveur. Les fichiers livrés sont liés à la commande et au compte partenaire.

✓ Une paire de clés par environnement, jamais partagée
✓ Secrets côté serveur, jamais dans une application distribuée
✓ Rotation des clés prévue dès la mise en service

Fiabilité de l'intégration : doublons, reprise, formats

Conservez dans votre base la correspondance entre vos commandes et vos dossiers, et vérifiez qu'une commande n'a pas déjà été émise avant de rejouer un appel après un incident réseau. Reportez-vous à la documentation pour les mécanismes de reprise disponibles. Côté réception, écrivez un traitement rejouable : c'est la précaution d'usage sur toute intégration par webhook.

L'API livre WAV et MP3, ainsi que des formats télécom sur demande selon l'endpoint et les options. Vérifiez en amont ce qu'attend l'équipement cible : la recommandation UIT-T G.711 définit deux lois de compression, la loi A et la loi mu, et la loi A est celle employée en Europe, en 8 kHz, 8 bits, mono. Certains équipements n'acceptent pas un fichier en qualité studio.

API et marque blanche

Beaucoup de partenaires combinent un portail en marque blanche pour les petits clients, et l'API pour les gros parcs et les opérations automatisées. La production sous-jacente est la même, avec la même supervision et les mêmes voix : un client qui passe du portail à l'API ne change pas de rendu sonore.

Rappelons notre modèle : nous vendons aux intégrateurs et aux opérateurs. Les PME passent par leur prestataire et, lorsqu'elles n'en ont pas, nous les mettons en relation avec un partenaire adapté. L'API est un outil de partenaire, pensé pour s'insérer dans votre offre.

Bénéfices techniques

Moins de saisie

Zéro ressaisie entre votre CRM et la production : le texte part de là où il est déjà écrit.

Scalabilité

Des centaines de sites équipés sans mobiliser d'équipe studio chez vous.

Traçabilité

Historique des commandes et des versions par client, exploitable par votre support.

Réactivité

Un message contextuel déclenché par automate reste utile le jour même.

Accéder à la documentation API

Consultez notre documentation OpenAPI, ouvrez un compte partenaire et demandez des clés de test : le chemin le plus rapide reste un POC sur un client pilote, avec deux ou trois messages réels plutôt qu'un jeu d'essai. Vérifiez à cette occasion les formats attendus par l'équipement cible, le mode de suivi retenu, interrogation du statut ou webhook, et l'endroit où le fichier doit atterrir dans votre chaîne de provisioning. Si vous hésitez entre API et portail en marque blanche, commencez par le portail, puis automatisez ce qui se répète.

Nous contacter

FAQ — API

Existe-t-il un bac à sable ? +

Des environnements de test sont disponibles pour les partenaires ; reportez-vous à la documentation à jour pour les modalités d'accès. Nous recommandons de traiter test et production comme deux environnements réellement distincts, avec des clés séparées.

Quels formats en sortie ? +

WAV, MP3 et formats télécom sur demande, selon l'endpoint et les options. Vérifiez en amont ce qu'accepte l'équipement cible : la téléphonie européenne s'appuie traditionnellement sur le G.711 loi A en 8 kHz mono, et certains équipements n'acceptent pas un fichier en qualité studio.

Des webhooks sont-ils disponibles ? +

Une notification de fin de production est possible selon configuration ; le détail figure dans la documentation API. Prévoyez un traitement rejouable côté réception, par précaution d'usage sur ce type d'intégration.

L'automatisation supprime-t-elle la relecture humaine ? +

Non. L'API automatise la commande et la livraison, pas la validation : chaque message est retravaillé et validé à la main avant d'être mis à disposition. C'est ce qui explique qu'une commande ne devienne pas un fichier dans la seconde.

Comment commander plusieurs messages pour un même déploiement ? +

Un déploiement multi-sites ou un serveur vocal composé de nombreux prompts se commande depuis votre automate, chaque message portant ses propres métadonnées client. Reportez-vous à la documentation pour les modalités de commande en volume.

Comment éviter les commandes en double ? +

Comment est facturé l'accès à l'API ? +

Nos conditions sont établies dans le cadre du partenariat, avec un fonctionnement par crédits décomptés au fil des commandes. Nous ne publions pas de tarif public : volumes et formats varient trop d'un partenaire à l'autre.

Guides, blog & ressources liés

Prêt à soigner la voix téléphonique de vos clients ?

Ouvrez un compte gratuit et testez le flux bout en bout — ou écrivez-nous si vous préférez en parler à quelqu'un avant.

Écrire à l'équipe